Agentic - Agents

Get the prompt for an agent

Get the prompt for an agent

post/api/v1/agentic/agents/prompt

Request

  • Base URL: https://api.voicelogica.ai
  • URL: https://api.voicelogica.ai/api/v1/agentic/agents/prompt
  • Auth: API key in header x-api-key

Headers

x-api-keystring required

Your API key for authentication. Required for all endpoints.

x-company-idstring

Optional company ID for resellers. When provided, the API request will operate on behalf of the specified subsidiary company. The API key must have access to the specified company.

Response

Prompt retrieved successfully

promptstring required

Main/systemic system prompt (agent.systemPrompt)

additionalCallSystemPromptstring

Additional call instructions from phone settings (agentPhoneSettings.systemPrompt). During calls both are merged at runtime.

agentIdstring

The agent ID. If not provided the default agent will be used

destination'prod' | 'version'

Where the prompt was written (update only)

agentVersionIdstring

Saved version id when destination was "version"

versionNumbernumber

Saved version number when destination was "version"

promptCharactersstring

Prompt size against the plan cap, e.g. "18420/20000". A write over the cap is REJECTED and nothing is saved, so check this before composing a longer prompt.

promptCharactersRemainingnumber

Characters still available before the plan cap is hit. Negative means the prompt would be rejected.

promptBudgetHintstring

Present only when prompt space is running low: tells you to move reference content to a knowledge file with add_knowledge_text instead of growing the prompt.

Changes

No recorded changes to this operation across all 2 revisions of this API.