Skip to main content
POST
/
v1
/
analyses
/
{analysis_id}
/
run
Run Analysis All
curl --request POST \
  --url https://api.example.com/v1/analyses/{analysis_id}/run \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "<string>",
    "status_url": "<string>"
  },
  "response_type": "RunAcceptedResponse",
  "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

Response for run endpoints indicating processing has been accepted.

​
data
RunAcceptedData · object
required

Minimal data for accepted run operations.

​
response_type
string
default:RunAcceptedResponse
​
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"
  }
]