INinkbox
Hosted Call Agent

Get Hosted Agent Config

Changed on
get/api/v1/phone/hosted-agent-config

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/phone/hosted-agent-config
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

agent_identity_idstring uuid nullable

Target identity. Agent-scoped keys resolve their own; required for admin/JWT.

Response

Successful Response

agent_identity_idstring required
voicestring nullable
modelstring nullable

Compatibility field; accepted values are not stored or used.

effective_voicestring required
effective_modelstring required

Informational platform-selected runtime identifier; not a configurable model.

instructionsstring nullable
authority_mode'contact_scoped' | 'yolo'

Changes

  • 5f73a313442dRevision changes
    • info

      the response's property default value changed from contact_scoped to yolo for the status

  • 9c6909511b73Revision changes
    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status

    • info

      removed the alloy enum value from the response property for the response status

    • info

      removed the andromeda enum value from the response property for the response status

    • info

      removed the apollo enum value from the response property for the response status

    • info

      removed the ara enum value from the response property for the response status

    • info

      removed the ash enum value from the response property for the response status

    • info

      removed the ballad enum value from the response property for the response status

    • info

      removed the cedar enum value from the response property for the response status

    • info

      removed the coral enum value from the response property for the response status

    • info

      removed the echo enum value from the response property for the response status

    • info

      removed the eddie enum value from the response property for the response status

    • info

      removed the eldrin enum value from the response property for the response status

    • info

      removed the eve enum value from the response property for the response status

    • info

      removed the marin enum value from the response property for the response status

    • info

      removed the orion enum value from the response property for the response status

    • info

      removed the rex enum value from the response property for the response status

    • info

      removed the sage enum value from the response property for the response status

    • info

      removed the shimmer enum value from the response property for the response status

    • info

      removed the talia enum value from the response property for the response status

    • info

      removed the thalia enum value from the response property for the response status

    • info

      removed the verse enum value from the response property for the response status

    • info

      the response's property pattern ^[a-z0-9][a-z0-9_-]{0,63}$ was added for the status