POST
/
v1
/
agent
import BeyondPresence from '@bey-dev/sdk';

const client = new BeyondPresence({
  apiKey: process.env['BEY_API_KEY'], // This is the default and can be omitted
});

const developerAgentResponse = await client.agent.create({
  avatar_id: '01234567-89ab-cdef-0123-456789abcdef',
  system_prompt: 'You are a helpful assistant.',
});

console.log(developerAgentResponse.id);
{
  "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
  "system_prompt": "You are a helpful assistant.",
  "name": "John Doe",
  "language": "en",
  "greeting": "Hello!",
  "max_session_length_minutes": 30,
  "capabilities": [
    "webcam_vision"
  ],
  "id": "01234567-89ab-cdef-0123-456789abcdef"
}

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Body

application/json

Request model for creating an agent.

Response

201
application/json

Successful Response

Response model for the agent.