GET
/
runs
/
{run_id}
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/runs/{run_id} \
  --header 'authorization: <authorization>' \
  --header 'x-organization-id: <x-organization-id>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "scheduled",
  "annotation": "correct",
  "timestamp": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "events": [
    {
      "type": "action",
      "timestamp": "2023-11-07T05:31:56Z",
      "integration_name": "<string>",
      "event_name": "<string>",
      "intermediate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "data": {},
        "error": "<string>",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "output": {},
      "node_id": "<string>"
    }
  ],
  "issues": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "open",
      "priority": "low",
      "created_at": "2023-11-07T05:31:56Z",
      "type": "transcriber",
      "updated_at": "2023-11-07T05:31:56Z",
      "assignee": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "correction": "<string>",
      "correction_reason": "<string>",
      "northstar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "name": "<string>",
    "is_published": true,
    "is_live": true,
    "source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "published_at": "2023-11-07T05:31:56Z",
    "is_deleted": true,
    "description": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

​
x-organization-id
string
required

The organization ID to use for the request. Required if your user is associated to more than one organization.

Path Parameters

​
run_id
string
required

Response

200
application/json
200

A run with all its events.

​
id
string
required
​
org_id
string
required
​
use_case_id
string
required
​
version_id
string
required
​
status
enum<string>
required
Available options:
scheduled,
running,
completed,
canceled,
failed
​
annotation
enum<string> | null
required
Available options:
correct,
incorrect,
critical
​
timestamp
string
required
​
completed_at
string | null
required

The timestamp of the last node output for the run.

​
events
object[]
required

The events for the run.

​
issues
object[]
required

The issues for the run.

​
version
object | null
required

The version for the run.

Was this page helpful?