> ## Documentation Index > Fetch the complete documentation index at: https://docs.equos.ai/llms.txt > Use this file to discover all available pages before exploring further. # Start an Equos avatar sesssion. ## OpenAPI ````yaml https://api.equos.ai/docs/v3-json post /v3/conversations openapi: 3.0.0 info: title: Equos.ai API description: API documentation for Equos.ai live platform. version: '3.0' contact: {} servers: - url: https://api.equos.ai security: [] tags: [] paths: /v3/conversations: post: tags: - Conversation summary: Start an Equos avatar sesssion. operationId: startConversation parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateEquosConversationRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CreateEquosConversationResponse' security: - x-api-key: [] components: schemas: CreateEquosConversationRequest: type: object properties: name: type: string characterId: type: string client: type: string nullable: true host: nullable: true allOf: - $ref: '#/components/schemas/EquosConversationHost' remoteAgent: nullable: true allOf: - $ref: '#/components/schemas/EquosParticipantIdentity' consumer: nullable: true allOf: - $ref: '#/components/schemas/EquosParticipantIdentity' maxSeconds: type: number nullable: true promptCtx: type: string nullable: true promptTemplateVars: type: object nullable: true additionalProperties: type: string required: - name - characterId CreateEquosConversationResponse: type: object properties: conversation: $ref: '#/components/schemas/EquosConversationWithCharacter' remoteAgentAccessToken: type: string nullable: true consumerAccessToken: type: string nullable: true required: - conversation EquosConversationHost: type: object properties: serverUrl: type: string accessToken: type: string required: - serverUrl - accessToken EquosParticipantIdentity: type: object properties: identity: type: string name: type: string required: - identity - name EquosConversationWithCharacter: type: object properties: id: type: string name: type: string client: type: string nullable: true status: type: string enum: - running - blocked - ended - error room: type: string nullable: true serverUrl: type: string nullable: true remoteAgentName: type: string nullable: true remoteAgentIdentity: type: string nullable: true consumerName: type: string nullable: true consumerIdentity: type: string nullable: true charge: type: boolean chargeBySecond: type: number maxSeconds: type: number promptCtx: type: string nullable: true promptTemplateVars: type: object nullable: true additionalProperties: type: string transcript: nullable: true deprecated: true type: array items: $ref: '#/components/schemas/EquosConversationUtterance' timeline: nullable: true type: array items: $ref: '#/components/schemas/EquosTimelineEntry' startedAt: format: date-time type: string joinedAt: format: date-time type: string nullable: true endedAt: format: date-time type: string nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string characterId: type: string organizationId: type: string character: $ref: '#/components/schemas/EquosCharacter' required: - id - name - status - charge - chargeBySecond - maxSeconds - startedAt - createdAt - updatedAt - characterId - organizationId - character EquosConversationUtterance: type: object properties: id: type: string author: type: string enum: - user - character content: type: string recordedAt: format: date-time type: string required: - id - author - content - recordedAt EquosTimelineEntry: type: object properties: type: type: string author: type: string content: type: string recordedAt: type: string required: - type - recordedAt EquosCharacter: type: object properties: id: type: string organizationId: type: string client: type: string nullable: true name: type: string livekitIdentity: type: string search: type: boolean elevenlabsAgentId: type: string nullable: true faceId: type: string nullable: true voiceId: type: string nullable: true brainId: type: string nullable: true knowledgeBaseId: type: string nullable: true face: nullable: true allOf: - $ref: '#/components/schemas/EquosFace' voice: nullable: true allOf: - $ref: '#/components/schemas/EquosVoice' brain: nullable: true allOf: - $ref: '#/components/schemas/EquosBrain' knowledgeBase: nullable: true allOf: - $ref: '#/components/schemas/EquosKnowledgeBase' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - organizationId - name - livekitIdentity - search - createdAt - updatedAt EquosFace: type: object properties: id: type: string identity: type: string enum: - tommy organizationId: type: string client: type: string nullable: true description: type: string nullable: true thumbnailUrl: type: string nullable: true referenceImgUrl: type: string nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - identity - organizationId - createdAt - updatedAt EquosVoice: type: object properties: id: type: string organizationId: type: string client: type: string nullable: true identity: type: string enum: - Puck - Charon - Kore - Fenrir - Aoede - Leda - Orus - Zephyr - Sulafat - Sadachbia - Sadaltager - Vindemiatrix - Zubenelgenubi - Achird - Pulcherrima - Gacrux - Schedar - Alnilam - Achernar - Laomedeia - Rasalgethi - Algenib - Erinome - Despina - Algieba - Umbriel - Iapetus - Enceladus - Autonoe - Callirrhoe instructions: type: string nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - organizationId - identity - createdAt - updatedAt EquosBrain: type: object properties: id: type: string organizationId: type: string client: type: string nullable: true instructions: type: string greetingMessage: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - organizationId - instructions - greetingMessage - createdAt - updatedAt EquosKnowledgeBase: type: object properties: id: type: string organizationId: type: string name: type: string description: type: string client: type: string documents: type: array items: $ref: '#/components/schemas/EquosDocument' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - organizationId - name - description - documents - createdAt - updatedAt EquosDocument: type: object properties: id: type: string knowledgeBaseId: type: string name: type: string description: type: string size: type: number status: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - knowledgeBaseId - name - description - size - status - createdAt - updatedAt securitySchemes: x-api-key: type: apiKey in: header name: x-api-key ````