get-api-deployment

curl --request GET \
  --url https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 200,
  "success": true,
  "data": {
    "id": "2230142097179373568",
    "assistantId": "2227823180112723968",
    "greetingInterruptible": false,
    "status": "active"
  }
}

GET

assistant-deployment

get-api-deployment

{assistantId}

get-api-deployment

curl --request GET \
  --url https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://assistant-01.in.rapida.ai/v1/assistant-deployment/get-api-deployment/{assistantId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 200,
  "success": true,
  "data": {
    "id": "2230142097179373568",
    "assistantId": "2227823180112723968",
    "greetingInterruptible": false,
    "status": "active"
  }
}

Authorizations

x-api-key

string

header

required

API key from Rapida credentials.

Headers

x-client-source

enum<string>

default:sdk

Client source identifier. SDK clients send this automatically.

Available options:

sdk

x-auth-id

string

Optional user identifier to propagate with the request.

Path Parameters

assistantId

string

required

Assistant ID for the deployment.

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

Response

Assistant API deployment.

code

integer<int32>

Example:

200

success

boolean

Example:

true

data

object

Hide child attributes

data.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.greeting

string

data.greetingInterruptible

boolean

data.mistake

string

data.inputAudio

object

Hide child attributes

data.inputAudio.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.inputAudio.audioType

string

data.inputAudio.audioProvider

string

data.inputAudio.audioOptions

object[]

Hide child attributes

data.inputAudio.audioOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.inputAudio.audioOptions.key

string

data.inputAudio.audioOptions.value

string

data.inputAudio.status

string

data.outputAudio

object

Hide child attributes

data.outputAudio.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.outputAudio.audioType

string

data.outputAudio.audioProvider

string

data.outputAudio.audioOptions

object[]

Hide child attributes

data.outputAudio.audioOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.outputAudio.audioOptions.key

string

data.outputAudio.audioOptions.value

string

data.outputAudio.status

string

data.status

string

data.maxSessionDuration

integer<uint64>

Required range: 180 <= x <= 600

data.idealTimeout

integer<uint64>

Required range: 15 <= x <= 120

data.idealTimeoutBackoff

integer<uint64>

Required range: 0 <= x <= 5

data.idealTimeoutMessage

string

error

object

Platform error response details. errorCode is a stable platform error code. See PlatformErrorCode for documented code/message mappings.

Hide child attributes

error.errorCode

string

Stable platform error code.

Pattern: ^[0-9]+$

Example:

"1002003"

error.errorMessage

string

Stable client-safe error message.

Example:

"missing toNumber parameter"

error.humanMessage

string

Client-safe human-readable message.

Example:

"Please provide the required toNumber parameter."

create-whatsapp-deployment

get-debugger-deployment

Assistant

Assistant deployments

Calls

get-api-deployment

Authorizations

Headers

Path Parameters

Response