GET
/
runs
/
{run_id}
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/runs/{run_id} \
  --header 'x-organization-id: <x-organization-id>'
{
  "run": {
    "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"
  },
  "sessions": [
    {
      "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",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "room_name": "<string>",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_number": "<string>",
      "status": "queued",
      "type": "outbound",
      "duration": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "messages": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "role": "assistant",
          "content": "<string>",
          "tool_calls": [
            {
              "function": {
                "name": "<string>",
                "arguments": "<string>"
              }
            }
          ],
          "name": "<string>",
          "is_filler": true,
          "is_interrupted": true,
          "latency_breakdown": {
            "network": 123,
            "initial_wait": 123,
            "transcriber": 123,
            "eos": 123,
            "eos_wait": 123,
            "llm": 123,
            "tts": 123
          },
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "node_outputs": [
        {
          "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",
          "chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "data": {},
          "is_multiple": true,
          "error": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "event": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": 123,
            "description": "<string>",
            "is_instant": true,
            "integration": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "group": "<string>",
              "icon": "<string>",
              "description": "<string>",
              "docs_url": "<string>",
              "website_url": "<string>",
              "is_top": true,
              "requires_credentials": true,
              "agent_specific": true
            }
          }
        }
      ]
    }
  ],
  "outputs": [
    {
      "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",
      "chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "data": {},
      "is_multiple": true,
      "error": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "event": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": 123,
        "description": "<string>",
        "is_instant": true,
        "integration": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "group": "<string>",
          "icon": "<string>",
          "description": "<string>",
          "docs_url": "<string>",
          "website_url": "<string>",
          "is_top": true,
          "requires_credentials": true,
          "agent_specific": true
        }
      }
    }
  ],
  "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>"
    }
  ],
  "intermediates": [
    "<any>"
  ],
  "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

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
​
run
object
required
​
sessions
object[]
required
​
outputs
object[]
required
​
issues
object[]
required
​
version
object | null
required
​
intermediates
(any | null)[]

Was this page helpful?

Get use cases runsPatch runs annotate