Read a published version | Rasen Developer API

{
  "id": "pub_01j00000000000000000000000",
  "agent_id": "agent_01j00000000000000000000000",
  "number": 1,
  "created_at": "2026-09-25T10:00:00Z",
  "prompt": "example",
  "voice": {
    "voice_id": "voice_01j00000000000000000000000"
  },
  "settings": {
    "purpose": null,
    "goals": [],
    "call_direction": null,
    "grammatical_gender": null,
    "additional_context": null,
    "language": "en",
    "agent_name": "example",
    "first_message": "example",
    "timezone": "Asia/Kolkata",
    "max_call_duration_seconds": 60,
    "inactivity_timeout_seconds": 1,
    "user_turn_timeout_ms": 250,
    "ivr_hangup": true,
    "voicemail_detection": true,
    "dtmf_enabled": true,
    "dtmf_timeout_seconds": 1,
    "dtmf_digit_limit": 1,
    "dtmf_termination_key": "#",
    "bg_audio": "office",
    "bg_volume": 0,
    "extraction_fields": [
      {
        "name": "appointment_confirmed",
        "type": "text",
        "description": "example",
        "required": true,
        "choices": [
          "example"
        ]
      }
    ]
  },
  "referenced_variables": [
    "example"
  ],
  "tool_ids": [
    "example"
  ],
  "retrieval_snapshot_id": "retrieval_snapshot_01j00000000000000000000000",
  "tools": [
    {
      "id": "tool_01j00000000000000000000000",
      "agent_id": "agent_01j00000000000000000000000",
      "revision": "example",
      "configuration": {
        "kind": "webhook",
        "deadline_ms": 8000,
        "definition": {
          "url": "https://api.example.com/orders",
          "method": "GET",
          "headers": [
            {
              "name": "Authorization",
              "value_type": "secret",
              "credential": {
                "secret_id": "sec_01j00000000000000000000000",
                "version": 1
              },
              "variable": "customer_name"
            }
          ],
          "parameters": [
            {
              "name": "lookup_order",
              "location": "path",
              "source": "model",
              "value": "example",
              "required": false,
              "schema": {
                "type": "string",
                "enum": [
                  "example"
                ],
                "description": "example",
                "minimum": 1,
                "maximum": 1
              }
            }
          ],
          "content_type": "application/json"
        },
        "description": "example",
        "effect_id_name": "example",
        "effect_id_placement": "header",
        "max_response_bytes": 32768,
        "name": "lookup_order",
        "retry_posture": "none",
        "side_effect": "none",
        "wait_for_response": true
      },
      "created_at": "2026-09-25T10:00:00Z"
    }
  ],
  "variables": [
    {
      "key": "customer_name",
      "value": "example",
      "description": "example",
      "sensitivity": "public",
      "redacted": true
    }
  ],
  "fallback_source_ids": [
    "example"
  ],
  "default_tools": {
    "end_call": {
      "enabled": true
    },
    "transfer": {
      "enabled": true,
      "destination_number": "+12025550123"
    }
  }
}

Public configuration and provenance only; no infrastructure manifest or credential values.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

agent_idstringRequired1-128 characters

Resource identity within the authenticated workspace.

version_idstringRequired1-128 characters

Resource identity within the authenticated workspace.

Response headers

X-Request-IdstringOptional

Safe server request correlation ID.

RateLimit-LimitintegerOptional

Requests allowed in the current window for the tightest applicable limit.

RateLimit-RemainingintegerOptional

Requests left in the current window.

RateLimit-ResetintegerOptional

Seconds until the current window resets.

Response

Read a published version.

idstring<=128 characters

Opaque pub identifier. Do not parse its contents.

agent_idstring<=128 characters

Opaque agent identifier. Do not parse its contents.

numberinteger>=1

created_atdatetime

promptstring

voiceobject

settingsobject

Effective settings after defaults resolve. Not a PATCH input.

referenced_variableslist of strings

tool_idslist of strings

retrieval_snapshot_idstring or null<=128 characters

toolslist of objects

variableslist of objects

fallback_source_idslist of strings

default_toolsobject

Effective built-in policies. end_call is enabled by default for every agent, including agents created before this field existed; only an explicit end_call.enabled=false policy turns it off. transfer starts disabled with a null destination. Publication freezes the policy; rollback restores it subject to current revocation. Clients must accept additional policy keys.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error