POST
/
agents
Create an agent
curl --request POST \
  --url https://api.proficientai.com/agents \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "display_description": "<string>",
  "display_name": "<string>",
  "greeting_message": "<string>",
  "initial_turn": "user",
  "model": "anthropic.claude-v1",
  "name": "<string>",
  "openai": {
    "frequency_penalty": 123,
    "presence_penalty": 123,
    "temperature": 123,
    "top_p": 123
  },
  "system_message": "<string>"
}'
{
  "id": "<string>",
  "object": "agent",
  "active": true,
  "description": "<string>",
  "display_description": "<string>",
  "display_name": "<string>",
  "name": "<string>",
  "created_at": 123,
  "updated_at": 123
}

Body

application/json

The data with which an agent is created.

Response

200
application/json
<p>An _agent_ is an AI entity that exists to serve your project's users. Agents are intelligent, configurable and context-aware and can interact with your users via a messaging system enabled by the Proficient API.</p>