Skip to main content
GET
Get PAL
For AI agents, use https://docs.tavus.io/openapi.yaml for the full HTTP API contract.
Pending edits from PAL Maker are not returned unless the deployments have been updated. See PAL editing lifecycle.

Authorizations

x-api-key
string
header
required

Path Parameters

pal_id
string
required

The unique identifier of the PAL.

Example:

"pcb7a34da5fe"

Response

pal_id
string

A unique identifier for the PAL.

Example:

"pcb7a34da5fe"

pal_name
string

A name for the PAL.

Example:

"Life Coach"

system_prompt
string

The system prompt that will be used by the llm.

Example:

"As a Life Coach, you are a dedicated professional who specializes in..."

default_face_id
string

The default face_id associated with this PAL if one exists.

Example:

"r90bbd427f71"

conferencing_email
string | null

The PAL's invitable meeting email on tavusinvite.com, derived from layers.conferencing.username. Present when conferencing is configured.

Example:

"acme-anna@tavusinvite.com"

disclosure_type
enum<string>
default:auto

AI disclosure setting for EU AI Act compliance. always, auto (default, follows the conversation's policy param), or off.

Available options:
always,
auto,
off
Example:

"auto"

verbal_disclosure
string

Text the PAL speaks before its greeting when disclosure_type fires. Empty falls back to "Just a note, I am an AI system, not a person."

Example:

"Just so you know, you're speaking with an AI agent from Acme."

visual_disclosure
string

Text shown as an on-screen banner when disclosure_type fires. Empty falls back to "You are interacting with an AI system."

Example:

"You are speaking with an AI agent."

document_ids
string[]

Array of document IDs that the PAL has access to. These documents will be available to the PAL in all their conversations. The document_ids are returned in the response of the Get Document and the Create Document endpoints.

Example:
document_tags
string[]

Array of document tags that the PAL has access to. Documents matching these tags will be available to the PAL in all their conversations.

Example:
layers
object
created_at
string

The date and time the PAL was created.

Example:

""

updated_at
string

The date and time of when the PAL was last updated.