Skip to main content
GET
/
v1
/
analyses
/
{analysis_id}
Get Analysis Description
curl --request GET \
  --url https://api.example.com/v1/analyses/{analysis_id} \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "owner_id": "<string>",
    "created_at": 123,
    "urls": [
      "<string>"
    ],
    "prompts": [
      {
        "id": "<string>",
        "idx": 123,
        "name": "<string>",
        "prompt": "<string>",
        "version": 123,
        "description": "<string>"
      }
    ],
    "description": "<string>",
    "last_run_at": 123
  },
  "response_type": "AnalysisDescriptionResponse",
  "links": []
}

Authorizations

​
X-API-Key
string
header
required

API Key for external integrations (format: greetincs_...)

Path Parameters

​
analysis_id
string
required

Analysis ID in TypeID format

Response

Successful Response

Analysis with loaded prompt details and URLs.

​
data
AnalysisDescriptionData · object
required

Analysis detail data.

​
response_type
string
default:AnalysisDescriptionResponse
​
links
Link · object[]

HATEOAS links related to this response (e.g., self, next, prev)

Example:
[
  {
    "href": "/resource/{resource_id}",
    "method": "GET",
    "rel": "self",
    "title": "Resource Details"
  },
  {
    "href": "/resource/{resource_id}/related",
    "method": "GET",
    "rel": "related",
    "title": "Related Resources"
  }
]