Skip to navigation

Get Dialogflow agent

View as MarkdownOpen in Claude

Retrieves one Dialogflow-backed AI Agent resource from your SignalWire project. Use List Dialogflow agents to find these resources, or Get AI agent for an agent configured directly in SignalWire.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Dialogflow Agent.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the Dialogflow Agent.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the Dialogflow Agent Fabric Resource
typeenum
Type of the Fabric Resource
Allowed values:
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
dialogflow_agentobject
Dialogflow Agent data.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error