Skip to main content
Create An Agent From A Template.
curl --request POST \
  --url https://{api_endpoint}/api/v1/orchestrate/agents/create-from-template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "category": "<string>",
  "version": "<string>",
  "description": "<string>",
  "spec": {
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "tools": [
      "<string>"
    ],
    "collaborators": [
      "<string>"
    ],
    "llm": "<string>",
    "style": "default",
    "supported_apps": [
      "slack/askhr"
    ],
    "glossary": [
      "<string>"
    ],
    "guidelines": [
      {
        "display_name": "<string>",
        "condition": "<string>",
        "action": "<string>",
        "tool": "<string>"
      }
    ],
    "knowledge_base": [
      "<string>"
    ],
    "hidden": false,
    "structured_output": {},
    "custom_join_tool": "<string>",
    "additional_properties": {
      "starter_prompts": {
        "customize": [
          {
            "id": "<string>",
            "title": "<string>",
            "subtitle": "<string>",
            "prompt": "<string>",
            "state": "<string>"
          }
        ]
      },
      "welcome_content": {
        "welcome_message": "<string>",
        "description": "<string>"
      }
    },
    "tags": [
      "<string>"
    ],
    "chat_with_docs": {
      "enabled": false,
      "supports_full_document": true,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10,
        "extraction_strategy": "standard"
      },
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "",
        "max_docs_passed_to_llm": 5,
        "generated_response_length": "Moderate",
        "display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
        "display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
        "idk_message": "I'\''m afraid I don'\''t understand. Please rephrase your question.",
        "enabled": true
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      },
      "query_source": "Agent",
      "agent_query_description": "The query to search for in the knowledge base"
    },
    "context_access_enabled": true,
    "context_variables": [
      "<string>"
    ],
    "hide_reasoning": false,
    "voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "restrictions": "editable",
    "bundled_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_mapping": {}
  },
  "dependencies": {}
}'
"<any>"

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

parent_agent_id

Body

application/json

Schema for creating an agent from template.

name
string
required

Name of the agent

category
string
required

Category of the agent

description
string
required

Description of what the agent does

spec
object
required

Agent specification

id
string<uuid> | null

Optional UUID for the agent

version
string | null

Version of the agent

dependencies
object

Dependencies including tools and agents

Response

Successful Response

The response is of type any.