Fetch Assistant from Provider

Fetches assistant name and system prompt from an external voice provider.

POST https://api.futureagi.com/simulate/api/agent-definition-operations/fetch_assistant_from_provider/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Request body

assistantId string Required

The assistant ID from the external provider’s platform.

apiKey string Required

API key for the external voice provider.

provider string Required

The voice provider to fetch from. Values: "vapi", "retell", "elevenLabs", "others".

name string Optional

Name override; returned instead of the provider-fetched name.

prompt string Optional

Prompt override; returned instead of the provider-fetched system prompt.

commitMessage string Optional

Commit message. Auto-generated with a timestamp if omitted.

Response

200 OK
assistantId string
The requested assistant ID.
apiKey string
The provider API key used.
name string
Assistant name from the provider or the override.
prompt string
System prompt from the provider or the override.
provider string
The queried provider.
commitMessage string
Provided or auto-generated commit message.

Errors

400 Bad Request Optional

Provider returned an error (invalid API key or assistant ID).

401 Unauthorized Optional

Invalid or missing API credentials.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE