Get Credential By Type

GET

api

credential

unity

{id}

type

{type}

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/credential/unity/{id}/type/{type} \
  --header 'Authorization: Bearer <token>'

{
  "credentials": [
    {
      "id": "<string>",
      "name": "<string>",
      "userId": "<string>",
      "unityId": "<string>",
      "integrationId": "<string>",
      "secretId": "<string>",
      "status": true,
      "virtualKey": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "integration": [
    {
      "id": "<string>",
      "name": "<string>",
      "iconId": "<string>",
      "type": "<string>",
      "status": true,
      "validationEndpoint": "<string>",
      "slug": "<string>",
      "form": [
        {
          "name": "<string>",
          "type": "<string>",
          "label": "<string>",
          "maxLenght": 123,
          "required": true
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "icon": {
        "id": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "institutionId": "<string>",
        "type": "<string>",
        "fileName": "<string>",
        "internalStorageUrl": "<string>",
        "url": "<string>",
        "size": 123,
        "extension": "<string>",
        "maskName": "<string>"
      }
    }
  ]
}

Body Description

string

required

The ID of Unity

type

string

required

The Type of Credential

Response Description

Below you will see the description of the Get all Credential by Type response

credentials

array

required

A list of credentials associated with integrations.

uuid

required

Unique identifier for the credential.

name

string

required

Name of the credential.

userId

uuid

required

Identifier of the associated user.

unityId

uuid

required

Identifier of the associated unity.

integrationId

uuid

required

Identifier of the integration associated with the credential.

secretId

uuid

required

Secret identifier for the credential.

status

boolean

required

Indicates whether the credential is active.

virtualKey

string

Virtual key associated with the credential.

createdAt

string

required

Date and time when the credential was created.

updatedAt

string

Date and time when the credential was last updated.

integration

array

required

Details about the integration associated with the credential.

uuid

required

Unique identifier for the integration.

name

string

required

Name of the integration.

iconId

uuid

required

Identifier of the associated icon.

type

string

required

Type of integration (e.g., llm).

status

boolean

required

Indicates whether the integration is active.

validationEndpoint

string

URL of the validation endpoint for the integration.

slug

string

Slug of the integration.

form

array

required

Form fields for integration configuration.

name

string

required

Name of the form field.

type

string

required

Type of the form field (e.g., string).

label

string

required

Label of the form field.

maxLenght

number

Maximum length of the form field value.

required

boolean

required

Indicates if the field is mandatory.

createdAt

string

required

Date and time when the integration was created.

updatedAt

string

Date and time when the integration was last updated.

icon

object

Details about the integration’s icon.

uuid

required

Unique identifier for the icon.

createdAt

string

required

Date and time when the icon was created.

updatedAt

string

Date and time when the icon was last updated.

institutionId

uuid

required

Identifier of the institution associated with the icon.

type

string

required

Type of icon (e.g., WidgetHeaderIcon).

fileName

string

required

File name of the icon.

internalStorageUrl

string

required

Internal storage URL of the icon.

url

string

required

Public URL of the icon.

size

number

required

Size of the icon in bytes.

extension

string

required

File extension of the icon.

maskName

string

Mask name associated with the icon.

Get Credential By Unity Update Credential

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/credential/unity/{id}/type/{type} \
  --header 'Authorization: Bearer <token>'

{
  "credentials": [
    {
      "id": "<string>",
      "name": "<string>",
      "userId": "<string>",
      "unityId": "<string>",
      "integrationId": "<string>",
      "secretId": "<string>",
      "status": true,
      "virtualKey": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "integration": [
    {
      "id": "<string>",
      "name": "<string>",
      "iconId": "<string>",
      "type": "<string>",
      "status": true,
      "validationEndpoint": "<string>",
      "slug": "<string>",
      "form": [
        {
          "name": "<string>",
          "type": "<string>",
          "label": "<string>",
          "maxLenght": 123,
          "required": true
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "icon": {
        "id": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "institutionId": "<string>",
        "type": "<string>",
        "fileName": "<string>",
        "internalStorageUrl": "<string>",
        "url": "<string>",
        "size": 123,
        "extension": "<string>",
        "maskName": "<string>"
      }
    }
  ]
}

Toolzz AI

​Body Description

​Response Description

Body Description

Response Description