Vocallabs API Docs

Create Authentication Token

POST

https://api.superflow.run/b2b/createAuthToken/

Request Parameters

Parameter	Type
clientId	string
clientSecret	string

Response Parameters

Parameter	Type
status	string
auth_token	string
id	string

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`

Request Body

JSON payload to send

json

{
	"clientId": "CLIENT_ID",
	"clientSecret": "CLIENT_SECRET"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/createAuthToken/' \
  -H 'Content-Type: application/json' \
  -d '{
	"clientId": "CLIENT_ID",
	"clientSecret": "CLIENT_SECRET"
}'

Get Wallet Balance

GET

https://api.superflow.run/b2b/getGreenBalance

Return the current wallet balance for your account.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/getGreenBalance' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Transaction History

GET

https://api.superflow.run/b2b/whatsubTransactionHistory

Paginated wallet transaction history ledger — every entry, newest first.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/whatsubTransactionHistory?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

SIP call API

POST

https://api.superflow.run/b2b/vocallabs/createSIPCall

SIP call API — call this endpoint to interact with call.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/11.0.2`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
  "phone_number": "NUMBER",
  "did": "DID",
  "websocket_url": "WEBSOCKET_URL",
  "webhook_url": "WEBHOOK_URL",
  "sample_rate": "SAMPLE_RATE"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createSIPCall' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/11.0.2' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "phone_number": "NUMBER",
  "did": "DID",
  "websocket_url": "WEBSOCKET_URL",
  "webhook_url": "WEBHOOK_URL",
  "sample_rate": "SAMPLE_RATE"
}
'

Initiate Call

POST

https://api.superflow.run/b2b/vocallabs/initiateVocallabsCall

Submit Initiate Call — kick off an asynchronous call operation.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"agentId": "AGENT_ID",
	"prospect_id": "PROSPECT_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/initiateVocallabsCall?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agentId": "AGENT_ID",
	"prospect_id": "PROSPECT_ID"
}'

Get Call Details

GET

https://api.superflow.run/b2b/vocallabs/getVocallabsCall

Return full detail for a single call by id.

Query Parameters

Parameter	Type	Required	Description
callId	string	no	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`callId`	`CALL_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVocallabsCall?callId=CALL_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Voices

GET

https://api.superflow.run/b2b/vocallabs/getVoices

Read Get Voices — fetch the requested resource.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVoices?0=' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call API Tokens

GET

https://api.superflow.run/b2b/vocallabs/getCallAPITokens

Read Get Call API Tokens — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallAPITokens?0=' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Call API

POST

https://api.superflow.run/b2b/vocallabs/initiateCallWebhook

Call API — call this endpoint to interact with call.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.0`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
  "from": "DID",
  "number": "NUMBER"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/initiateCallWebhook' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.0' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "from": "DID",
  "number": "NUMBER"
}
'

Get Call Timeline

GET

https://api.superflow.run/b2b/vocallabs/getCallTimeline

Read Get Call Timeline — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
phone_to	string	no	phone to
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`phone_to`	`PHONE_TO`
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallTimeline?phone_to=PHONE_TO&limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Daily Calls

GET

https://api.superflow.run/b2b/vocallabs/getDailyCalls

Read Get Daily Calls — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
start_date	string	no	inclusive window start (`YYYY-MM-DD`)

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`start_date`	`START_DATE`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getDailyCalls?start_date=START_DATE' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Websocket url

GET

https://api.superflow.run/b2b/vocallabs/getWebsocketUrl

Read Get Websocket url — fetch the requested resource.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent
prospect_id	string	yes	id of the prospect

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`
`prospect_id`	`PROSPECT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getWebsocketUrl?agent_id=AGENT_ID&prospect_id=PROSPECT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Audit one

GET

https://api.superflow.run/b2b/vocallabs/getOneAudit

Read Get Audit one — fetch the requested resource.

Query Parameters

Parameter	Type	Required	Description
call_id	string	yes	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`call_id`	`CALL_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getOneAudit?call_id=CALL_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Audits

GET

https://api.superflow.run/b2b/vocallabs/getAllAudits

Read Get Audits — fetch the requested resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAllAudits' \
  -H 'Authorization: Bearer AUTH_TOKEN'

upload audio Url

POST

https://api.superflow.run/b2b/vocallabs/uploadAudits

Upload a resource payload to your account.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.0`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"agent_id": "AGENT_ID",
	"recording_url": [
		"example1.wav",
		"example2.wav"
	]
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/uploadAudits' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.0' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": "AGENT_ID",
	"recording_url": [
		"example1.wav",
		"example2.wav"
	]
}

'

Create Direct Call

POST

https://api.superflow.run/b2b/vocallabs/createDirectCall

Create a new call. Returns its id for subsequent lookup.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"client_token_id": "CLIENT_TOKEN_ID",
	"number": "NUMBER"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createDirectCall?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"client_token_id": "CLIENT_TOKEN_ID",
	"number": "NUMBER"
}'

Hangup Call

POST

https://api.superflow.run/b2b/vocallabs/hangupCall

Hangup Call — call this endpoint to interact with call.

Query Parameters

Parameter	Type	Required	Description
	string	no

Request Body Parameters

Parameter	Type	Required	Description
call_id	string	yes	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"call_id": "3aa6340b-8b4b-4bc7-923f-614e1ee28318"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/hangupCall?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"call_id": "3aa6340b-8b4b-4bc7-923f-614e1ee28318"
}'

Get Agents

GET

https://api.superflow.run/b2b/vocallabs/getAIAgents

Read Get Agents — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAIAgents?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent By ID

GET

https://api.superflow.run/b2b/vocallabs/getAIAgentByID

Read Get Agent By ID — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAIAgentByID?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create New Agent

POST

https://api.superflow.run/b2b/vocallabs/createAIAgent

Create a new agent. Returns its id for subsequent lookup.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"name" : "AGENT_NAME"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createAIAgent?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name" : "AGENT_NAME"
}'

Update Agent by ID

POST

https://api.superflow.run/b2b/vocallabs/updateAIAgent

Update fields on an existing agent.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`

Request Body

JSON payload to send

json

{
	"agent_id": 
"AGENT_ID",
"name": 
"AGENT_NAME",
"inputs_needed": 
{
"contact_id": 
"CONTACT_ID"
},
"welcome_message": 
"AGENT_WELCOME_MESSAGE",
"agent_prompt": 
"Hello , your ID is .",
"analytics_prompt": 
"AGENT_ANALYTICS_PROMPT",
"language": 
"AGENT_LANGUAGE",
"call_token_id": 
"CALL_TOKEN_ID",
"voice_id": 
"VOICE_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAIAgent?agent_id=AGENT_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": 
"AGENT_ID",
"name": 
"AGENT_NAME",
"inputs_needed": 
{
"contact_id": 
"CONTACT_ID"
},
"welcome_message": 
"AGENT_WELCOME_MESSAGE",
"agent_prompt": 
"Hello , your ID is .",
"analytics_prompt": 
"AGENT_ANALYTICS_PROMPT",
"language": 
"AGENT_LANGUAGE",
"call_token_id": 
"CALL_TOKEN_ID",
"voice_id": 
"VOICE_ID"
}'

Get Agent Templates

GET

https://api.superflow.run/b2b/vocallabs/getAgentTemplates

Read Get Agent Templates — fetch the requested agent.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentTemplates' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get voices by language

GET

https://api.superflow.run/b2b/vocallabs/getVoicesByLanguageComment

Read Get voices by language — fetch the requested resource.

Query Parameters

Parameter	Type	Required	Description
language	string	no	BCP-47 language tag (e.g. `en-US`)
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`language`	`ENGLISH`
`1`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVoicesByLanguageComment?1=&language=ENGLISH' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Toggle favorite

POST

https://api.superflow.run/b2b/vocallabs/toggleFavorite

Flip the on/off state of a resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	
"agent_id": 
"AGENT_ID",
"favorite": 
true
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/toggleFavorite' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"agent_id": 
"AGENT_ID",
"favorite": 
true
}'

update visibility of agent

POST

https://api.superflow.run/b2b/vocallabs/updateAgentShared

Update fields on an existing agent.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	
"agent_id": 
"AGENT_ID",
"isShared": 
true
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAgentShared' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"agent_id": 
"AGENT_ID",
"isShared": 
true
}'

Agent prompt History

POST

https://api.superflow.run/b2b/vocallabs/agentPromptHistory

Agent prompt History — call this endpoint to interact with agent.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	
"agent_id": "AGENT_ID"

}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/agentPromptHistory' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"agent_id": "AGENT_ID"

}'

Update success metric

POST

https://api.superflow.run/b2b/vocallabs/updateSuccessMetric

Update fields on an existing resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	

"agent_id": 
"AGENT_ID",
"success_metric": 
{
"description": 
"<e.g. user is satisfied>",
	"another thing": "<desciption of another thing>"
}
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateSuccessMetric' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"agent_id": 
"AGENT_ID",
"success_metric": 
{
"description": 
"<e.g. user is satisfied>",
	"another thing": "<desciption of another thing>"
}
}'

Update whatsapp notification

POST

https://api.superflow.run/b2b/vocallabs/updateWhatsappNotification

Update fields on an existing resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateWhatsappNotification' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}'

Update mail notification

POST

https://api.superflow.run/b2b/vocallabs/updateMailNotification

Update fields on an existing resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateMailNotification' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}'

Get Agent Document

GET

https://api.superflow.run/b2b/vocallabs/getAgentDocuments

Read Get Agent Document — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentDocuments?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Insert Agent documents

POST

https://api.superflow.run/b2b/vocallabs/insertAgentDocx

Insert Agent documents — call this endpoint to interact with agent.

Request Body Parameters

Parameter	Type	Required	Description
file_name	string	yes	file name
file_url	string	yes	URL string
file_type	string	yes	file type
site_url	string	yes	URL string
webcrawler_depth	int	yes	webcrawler depth
crawl_status	string	yes	crawl status

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	

"file_name": 
"<your file name>",
"file_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"file_type": 
"<file type>",
"site_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"webcrawler_depth": 2,
"crawl_status": 
"<crawl status>"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/insertAgentDocx' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"file_name": 
"<your file name>",
"file_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"file_type": 
"<file type>",
"site_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"webcrawler_depth": 2,
"crawl_status": 
"<crawl status>"
}'

Get AI models

GET

https://api.superflow.run/b2b/vocallabs/getAIModels

Read Get AI models — fetch the requested resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAIModels' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent reschedule

GET

https://api.superflow.run/b2b/vocallabs/getAgentActions

Read Get Agent reschedule — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentActions?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Agent reschedule

POST

https://api.superflow.run/b2b/vocallabs/updateAgentReschedule

Update fields on an existing agent.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"agent_id": "AGENT_ID",
	"reschedule": true
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAgentReschedule?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": "AGENT_ID",
	"reschedule": true
}'

Get agent keyword replacements

GET

https://api.superflow.run/b2b/vocallabs/getKeywordReplacements

Read Get agent keyword replacements — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getKeywordReplacements?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get agent keywords

GET

https://api.superflow.run/b2b/vocallabs/getAgentKeywords

Read Get agent keywords — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentKeywords?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Add keywords replacements

POST

https://api.superflow.run/b2b/vocallabs/addKeyword

Create a new keyword. Returns its id for subsequent lookup.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
"objects": 
[
{
"agent_id": 
"AGENT_ID",
"keyword": 
"<keywords>",
"replacement": 
"<its replacement>"
}
]

}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addKeyword' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"objects": 
[
{
"agent_id": 
"AGENT_ID",
"keyword": 
"<keywords>",
"replacement": 
"<its replacement>"
}
]

}'

update keyword replacement

POST

https://api.superflow.run/b2b/vocallabs/updateKeyword

Update fields on an existing keyword.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
"keyword_id": 
"KEYWORD_ID",
"keyword": 
"<keyword>",
"replacement": 
"<its replacement>"

}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateKeyword' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"keyword_id": 
"KEYWORD_ID",
"keyword": 
"<keyword>",
"replacement": 
"<its replacement>"

}'

delete keyword replacement

DELETE

https://api.superflow.run/b2b/vocallabs/deleteKeyword

Delete the specified keyword. Idempotent: returns success if already gone.

Query Parameters

Parameter	Type	Required	Description
keyword_id	string	yes	id of the keyword

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`keyword_id`	`KEYWORD_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteKeyword?keyword_id=KEYWORD_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent template

GET

https://api.superflow.run/b2b/vocallabs/getTemplate

Read Get Agent template — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
template_agent_id	string	yes	id of the template agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`template_agent_id`	`TEMPLATE_AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getTemplate?template_agent_id=TEMPLATE_AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent samples

GET

https://api.superflow.run/b2b/vocallabs/getAgentSamples

Read Get Agent samples — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
template_agent_id	string	yes	id of the template agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`template_agent_id`	`TEMPLATE_AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentSamples?template_agent_id=TEMPLATE_AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent FAQs

GET

https://api.superflow.run/b2b/vocallabs/getAgentFaq

Read Get Agent FAQs — fetch the requested agent.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentFaq?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Insert Agent FAQs

POST

https://api.superflow.run/b2b/vocallabs/agentFaq

Insert Agent FAQs — call this endpoint to interact with agent.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"agent_id": "AGENT_ID",
"ques_data": "<ques>",
"ans_data": "<ans>",
	"operation": "<delete|insert|update>",
"faq_id": "<faq-id> (not required in insert)"


}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/agentFaq?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": "AGENT_ID",
"ques_data": "<ques>",
"ans_data": "<ans>",
	"operation": "<delete|insert|update>",
"faq_id": "<faq-id> (not required in insert)"


}'

Get Call statuses

GET

https://api.superflow.run/b2b/vocallabs/getCallStatuses

Return full detail for a single call by id.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallStatuses' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Conversation

GET

https://api.superflow.run/b2b/vocallabs/getCallConversation

Read Get Call Conversation — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
call_id	string	yes	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`call_id`	`CALL_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallConversation?call_id=CALL_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Data

GET

https://api.superflow.run/b2b/vocallabs/getCallData

Read Get Call Data — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
call_id	string	yes	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`call_id`	`CALL_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallData?call_id=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Status

GET

https://api.superflow.run/b2b/vocallabs/getCallStatus

Return full detail for a single call by id.

Query Parameters

Parameter	Type	Required	Description
call_id	string	yes	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`call_id`	`CALL_ID`

Request Body

JSON payload to send

json

{}

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallStatus?call_id=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Summary

GET

https://api.superflow.run/b2b/vocallabs/getCallSummary

Read Get Call Summary — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
call_id	string	yes	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`call_id`	`CALL_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallSummary?call_id=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

get post call data

GET

https://api.superflow.run/b2b/vocallabs/getPostCallData

Read get post call data — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
agent_id	string	yes	id of the agent
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`agent_id`	`AGENT_ID`
`1`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getPostCallData?1=&agent_id=AGENT_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Post Call Data

POST

https://api.superflow.run/b2b/vocallabs/updatePostCallData

Update fields on an existing call.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	
"call_id": "CALL_ID",
"key": "<key>",
"prompt": "<prompt for getting the key>"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updatePostCallData?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"call_id": "CALL_ID",
"key": "<key>",
"prompt": "<prompt for getting the key>"
}'

Delete Post Call Data

POST

https://api.superflow.run/b2b/vocallabs/deletePostCallData

Delete the specified call. Idempotent: returns success if already gone.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	
"call_id": 
"CALL_ID"

}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/deletePostCallData?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"call_id": 
"CALL_ID"

}'

Get vocallabs Call Data

GET

https://api.superflow.run/b2b/vocallabs/getVocallabsCall

Read Get vocallabs Call Data — fetch the requested call.

Query Parameters

Parameter	Type	Required	Description
callId	string	no	id of the call

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`callId`	`CALL_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVocallabsCall?callId=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Contact Group

POST

https://api.superflow.run/b2b/vocallabs/createContactGroup

Create a new contact. Returns its id for subsequent lookup.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"name": "CONTACT_GROUP_NAME"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createContactGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CONTACT_GROUP_NAME"
}'

Create Contact in Group

POST

https://api.superflow.run/b2b/vocallabs/createContactInGroup

Create a new contact. Returns its id for subsequent lookup.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"name": "CONTACT_NAME",
	"phone":"NUMBER",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createContactInGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CONTACT_NAME",
	"phone":"NUMBER",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}'

Update Contact Metadata in Group

POST

https://api.superflow.run/b2b/vocallabs/updateContactMetadata

Update fields on an existing contact.

Query Parameters

Parameter	Type	Required	Description
prospect_id	string	yes	id of the prospect

Request Body Parameters

Parameter	Type	Required	Description
metadata	object	yes	metadata

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`prospect_id`	`PROSPECT_ID`

Request Body

JSON payload to send

json

{
	"metadata": {
		"key": "value"
	}
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateContactMetadata?prospect_id=PROSPECT_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"metadata": {
		"key": "value"
	}
}'

Get Contact Group

GET

https://api.superflow.run/b2b/vocallabs/getContactGroups

Read Get Contact Group — fetch the requested contact.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContactGroups?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Contact Group

POST

https://api.superflow.run/b2b/vocallabs/updateContactGroup

Update fields on an existing contact.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"client_id": 
"USERID",
"id": 
"PROSPECT_GROUP_ID",
"name": 
"CONTACT_GROUP_NAME"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateContactGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"client_id": 
"USERID",
"id": 
"PROSPECT_GROUP_ID",
"name": 
"CONTACT_GROUP_NAME"
}'

Delete Contact Group

DELETE

https://api.superflow.run/b2b/vocallabs/deleteContactGroup

Delete the specified contact. Idempotent: returns success if already gone.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
"id": 
"{{ _.prospect_groups_id }}"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteContactGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"id": 
"{{ _.prospect_groups_id }}"
}'

Delete Contact

DELETE

https://api.superflow.run/b2b/vocallabs/deleteContact

Delete the specified contact. Idempotent: returns success if already gone.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
"contact_id": 
"CONTACT_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteContact?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"contact_id": 
"CONTACT_ID"
}'

Get Contacts

GET

https://api.superflow.run/b2b/vocallabs/getContacts

Read Get Contacts — fetch the requested contact.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContacts?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Add multiple contacts to group

POST

https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroup

Create a new contact. Returns its id for subsequent lookup.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroup' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}
'

Get Contact Data

GET

https://api.superflow.run/b2b/vocallabs/getContactData

Read Get Contact Data — fetch the requested contact.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination
prospect_id	string	yes	id of the prospect

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`
`prospect_id`	`PROSPECT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContactData?limit=LIMIT&offset=OFFSET&prospect_id=PROSPECT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Contact Data

POST

https://api.superflow.run/b2b/vocallabs/updateContactData

Update fields on an existing contact.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"prospect_id": 
"PROSPECT_ID",
"data": 
{
"<key>": 
"<value>",
"<key2>": 
"<value2>"
}
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateContactData?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"prospect_id": 
"PROSPECT_ID",
"data": 
{
"<key>": 
"<value>",
"<key2>": 
"<value2>"
}
}'

Get Contact

GET

https://api.superflow.run/b2b/vocallabs/getContact

Read Get Contact — fetch the requested contact.

Query Parameters

Parameter	Type	Required	Description
prospect_id	string	yes	id of the prospect

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`prospect_id`	`PROSPECT_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContact?prospect_id=PROSPECT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Contact Group V2

POST

https://api.superflow.run/b2b/vocallabs/createContactGroupV2

Create a new contact. Returns its id for subsequent lookup.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{
	"name": "CONTACT_GROUP_NAME"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createContactGroupV2?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CONTACT_GROUP_NAME"
}'

Add multiple contacts to group V2

POST

https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroupV2

Create a new contact. Returns its id for subsequent lookup.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroupV2' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}
'

Get Actions

GET

https://api.superflow.run/b2b/vocallabs/getActions

Read Get Actions — fetch the requested agent action.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActions' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Action

POST

https://api.superflow.run/b2b/vocallabs/createAction

Create a new agent action. Returns its id for subsequent lookup.

Query Parameters

Parameter	Type	Required	Description
	string	no

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`0`

Request Body

JSON payload to send

json

{	
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createAction?0=' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{	
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}'

Update Action

POST

https://api.superflow.run/b2b/vocallabs/updateAction

Update fields on an existing agent action.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"id" : "ACTION_ID",
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAction' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "ACTION_ID",
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}'

Delete Action

DELETE

https://api.superflow.run/b2b/vocallabs/deleteAction

Delete the specified agent action. Idempotent: returns success if already gone.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"id" : "ACTION_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteAction' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "ACTION_ID"
}'

Get Documents

GET

https://api.superflow.run/b2b/vocallabs/getDocuments

Read Get Documents — fetch the requested knowledge document.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getDocuments' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Delete Document

DELETE

https://api.superflow.run/b2b/vocallabs/deleteDocument

Delete the specified knowledge document. Idempotent: returns success if already gone.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"id" : "DOCUMENT_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteDocument' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "DOCUMENT_ID"
}'

Get Action templates

GET

https://api.superflow.run/b2b/vocallabs/getActionTemplates

Read Get Action templates — fetch the requested agent action.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionTemplates' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action template details

GET

https://api.superflow.run/b2b/vocallabs/getActionTemplateDetails

Return full detail for a single agent action by id.

Query Parameters

Parameter	Type	Required	Description
template_action_id	string	yes	id of the template action

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`template_action_id`	`TEMPLATE_ACTION_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionTemplateDetails?template_action_id=TEMPLATE_ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action Parameter

GET

https://api.superflow.run/b2b/vocallabs/getActionParameters

Read Get Action Parameter — fetch the requested agent action.

Query Parameters

Parameter	Type	Required	Description
action_id	string	yes	id of the action

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`action_id`	`ACTION_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionParameters?action_id=ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action fields

GET

https://api.superflow.run/b2b/vocallabs/getActionFields

Read Get Action fields — fetch the requested agent action.

Query Parameters

Parameter	Type	Required	Description
action_id	string	yes	id of the action

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`action_id`	`ACTION_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionFields?action_id=ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action Configuration

GET

https://api.superflow.run/b2b/vocallabs/getActionConfiguration

Read Get Action Configuration — fetch the requested agent action.

Query Parameters

Parameter	Type	Required	Description
action_id	string	yes	id of the action

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`action_id`	`ACTION_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionConfiguration?action_id=ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Flows

GET

https://api.superflow.run/b2b/vocallabs/getFlows

Read Get Flows — fetch the requested agent flow.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getFlows' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Identity Url

POST

https://api.superflow.run/b2b/vocallabs/getIdentityUrl

Read Get Identity Url — fetch the requested resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"flow_id": "FLOW_ID",
"prospect_id": "PROSPECT_ID",

"verification_type": "aadhaar or pan",
"created_at": "2025-10-09T12:05:17.875Z" 

}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/getIdentityUrl' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"flow_id": "FLOW_ID",
"prospect_id": "PROSPECT_ID",

"verification_type": "aadhaar or pan",
"created_at": "2025-10-09T12:05:17.875Z" 

}'

Get Dashboard stats

GET

https://api.superflow.run/b2b/vocallabs/getDashboardStats

Read Get Dashboard stats — fetch the requested dashboard data.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/11.1.0`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getDashboardStats' \
  -H 'User-Agent: insomnia/11.1.0' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Tokens

GET

https://api.superflow.run/b2b/vocallabs/getTokens

Read Get Tokens — fetch the requested resource.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/11.1.0`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getTokens' \
  -H 'User-Agent: insomnia/11.1.0' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Campaigns

GET

https://api.superflow.run/b2b/vocallabs/getCampaigns

Read Get Campaigns — fetch the requested campaign.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCampaigns' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Campaign

POST

https://api.superflow.run/b2b/vocallabs/createCampaign

Create a new campaign. Returns its id for subsequent lookup.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"name": "CAMPAIGN_NAME",
	"agent_id": "AGENT_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CAMPAIGN_NAME",
	"agent_id": "AGENT_ID"
}'

Update Campaign

POST

https://api.superflow.run/b2b/vocallabs/updateCampaign

Update fields on an existing campaign.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"campaign_id": "CAMPAIGN_ID",
	"campaign_name": "CAMPAIGN_NAME"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"campaign_id": "CAMPAIGN_ID",
	"campaign_name": "CAMPAIGN_NAME"
}'

Delete Campaign

DELETE

https://api.superflow.run/b2b/vocallabs/deleteCampaign

Delete the specified campaign. Idempotent: returns success if already gone.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"id" : "CAMPAIGN_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "CAMPAIGN_ID"
}'

Get Queueing Details

GET

https://api.superflow.run/b2b/vocallabs/getQueueingDetails

Return full detail for a single resource by id.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination
campaign_id	string	yes	id of the campaign

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`
`campaign_id`	`CAMPAIGN_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getQueueingDetails?limit=LIMIT&offset=OFFSET&campaign_id=CAMPAIGN_ID' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Campaign Status

GET

https://api.superflow.run/b2b/vocallabs/getCampaignStatus

Return full detail for a single campaign by id.

Query Parameters

Parameter	Type	Required	Description
campaign_id	string	yes	id of the campaign

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`campaign_id`	`CAMPAIGN_ID`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCampaignStatus?campaign_id=CAMPAIGN_ID' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Campaign Status

POST

https://api.superflow.run/b2b/vocallabs/updateCampaignStatus

Update fields on an existing campaign.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	
"campaign_id": 
"CAMPAIGN_ID",
	"active": false

}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateCampaignStatus' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"campaign_id": 
"CAMPAIGN_ID",
	"active": false

}'

Add Contacts to Campaign

POST

https://api.superflow.run/b2b/vocallabs/addContactsToCampaign

Create a new contact. Returns its id for subsequent lookup.

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/11.1.0`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"user_id": "CLIENT_ID",
	"campaign_id": "CAMPAIGN_ID",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addContactsToCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/11.1.0' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"user_id": "CLIENT_ID",
	"campaign_id": "CAMPAIGN_ID",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}'

Fetch Available Numbers

GET

https://api.superflow.run/b2b/vocallabs/fetchAvailableNumbers

Read Fetch Available Numbers — fetch the requested resource.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/fetchAvailableNumbers?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Your Numbers

GET

https://api.superflow.run/b2b/vocallabs/getNumbers

Read Get Your Numbers — fetch the requested resource.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getNumbers?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Fetch Countries

GET

https://api.superflow.run/b2b/vocallabs/fetchCountries

Read Fetch Countries — fetch the requested resource.

Query Parameters

Parameter	Type	Required	Description
limit	int	no	max rows per page
offset	int	no	rows to skip for pagination

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Appended to the URL as ?key=value

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

Ready-to-run snippets in your language

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/fetchCountries?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Bridge Call

POST

https://api.superflow.run/b2b/vocallabs/conference-call

Bridge Call — connect two phone numbers in a single conference.

Headers

Header	Required	Description
Authorization	yes	`Bearer <auth_token>` user JWT

Request Body Parameters

Parameter	Type	Required	Description
phone_1	string	yes	first leg phone number
phone_2	string	yes	second leg phone number
client_token_id	string	yes	id of the client token

Response

Field	Type	Notes
status	string	`success` on 200
data	object	endpoint-specific payload

Errors

Status	Message	When
401	unauthorized	bearer `auth_token` missing/invalid
400	invalid params	required field missing or malformed
402	insufficient balance	wallet cannot cover the request (if billable)
404	not found	referenced resource does not exist

Headers

Request headers sent with this endpoint

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/12.6.0`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

JSON payload to send

json

{
	"phone_1": "PHONE_1",
	"phone_2": "PHONE_2",
	"client_token_id": "CLIENT_TOKEN_ID"
}

Code Examples

Ready-to-run snippets in your language

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/conference-call' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/12.6.0' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"phone_1": "PHONE_1",
	"phone_2": "PHONE_2",
	"client_token_id": "CLIENT_TOKEN_ID"
}'