Agents

Agent related APIs

에이전트 얻기

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

emailany ofOptional

stringOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

알겠습니다.

application/json

get

/webapi/v2/agents

HTTPcURLJavaScriptPython

GET /webapi/v2/agents HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

알겠습니다.

{
  "agents": [
    {
      "id": "text",
      "lastName": "text",
      "firstName": "text",
      "email": "text"
    }
  ]
}

Get Agent Detail

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

agent_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

application/json

get

/webapi/v2/agents/{agent_id}

HTTPcURLJavaScriptPython

GET /webapi/v2/agents/{agent_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "id": "text",
  "lastName": "text",
  "firstName": "text",
  "email": "text"
}

프로젝트의 모든 싱글액션 앱 도구를 검색하십시오.

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

싱글액션 앱 도구를 성공적으로 검색했습니다.

application/json

get

/webapi/agent_builder/single_action_app_tools

HTTPcURLJavaScriptPython

GET /webapi/agent_builder/single_action_app_tools HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

싱글액션 앱 도구를 성공적으로 검색했습니다.

{
  "tools": [
    {
      "id": "text",
      "name": "text",
      "display_name": "text",
      "description": "text",
      "single_action_inputs": [
        {
          "name": "text",
          "type": "text",
          "description": "text"
        }
      ]
    }
  ]
}

특정 싱글액션 앱 도구를 이름으로 검색하십시오.

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

tool_namestringRequired

Name of the tool to retrieve

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

싱글액션 앱 도구를 성공적으로 검색했습니다.

application/json

404

도구를 찾을 수 없습니다.

application/json

get

/webapi/agent_builder/single_action_app_tool/{tool_name}

HTTPcURLJavaScriptPython

GET /webapi/agent_builder/single_action_app_tool/{tool_name} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "tool": {
    "id": "text",
    "name": "text",
    "display_name": "text",
    "description": "text",
    "single_action_inputs": [
      {
        "name": "text",
        "type": "text",
        "description": "text"
      }
    ]
  }
}

Retrieve all agent tools for the project

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

Successfully retrieved agent tools

application/json

get

/webapi/agent_builder/agent_tools

HTTPcURLJavaScriptPython

GET /webapi/agent_builder/agent_tools HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

Successfully retrieved agent tools

{
  "tools": [
    {
      "id": "text",
      "name": "text",
      "display_name": "text",
      "description": "text",
      "project_id": "text",
      "published": true,
      "variables": [
        {
          "name": "text",
          "type": "text",
          "description": "text",
          "required": true
        }
      ]
    }
  ]
}

Retrieve a specific agent tool by its name

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

tool_namestringRequired

Name of the agent tool to retrieve

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

Successfully retrieved the agent tool

application/json

404

Agent tool not found

get

/webapi/agent_builder/agent_tool/{tool_name}

HTTPcURLJavaScriptPython

GET /webapi/agent_builder/agent_tool/{tool_name} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "tool": {}
}

Retrieve OAuth2 information by state

post

Get OAuth2 configuration information for an AI agent using the OAuth state parameter

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

statestringRequired

OAuth2 state parameter to identify the OAuth configuration

Responses

200

Successfully retrieved OAuth2 information

application/json

400

Bad request - invalid input

application/json

404

OAuth2 information not found

application/json

post

/webapi/agent_builder/oauth2_information

HTTPcURLJavaScriptPython

POST /webapi/agent_builder/oauth2_information HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "state": "text"
}

{
  "success": true,
  "oauth2_info": {
    "id": "text",
    "hub_id": "text",
    "configuration_name": "text",
    "authorization_url": "text",
    "token_url": "text",
    "client_id": "text",
    "client_secret": "text",
    "scope": [
      "text"
    ],
    "redirect_uri": "text",
    "place_access_token": "text",
    "place_expires_in": "text",
    "place_refresh_token": "text",
    "place_token_type": "text",
    "headers": {},
    "additional": {},
    "token_info": {},
    "token_generated": 1,
    "state": "text",
    "code_verifier": "text"
  }
}

Update OAuth2 token information

post

Update OAuth2 token information (tokenInfo and tokenGenerated) for an existing OAuth configuration

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

statestringRequired

OAuth2 state parameter to identify the OAuth configuration

tokenInfoobjectOptional

Updated token information

tokenGeneratednumberOptional

Timestamp when the token was generated

Responses

200

Successfully updated OAuth2 information

application/json

400

Bad request - invalid input

application/json

404

OAuth2 information not found

application/json

post

/webapi/agent_builder/oauth2_information/update

HTTPcURLJavaScriptPython

POST /webapi/agent_builder/oauth2_information/update HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "state": "text",
  "tokenInfo": {},
  "tokenGenerated": 1
}

{
  "success": true
}

에이전트 관리

post

프로젝트에서 에이전트를 생성 및 삭제하는 데 사용됨

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

emailstringOptional

생성하거나 삭제하려는 에이전트의 이메일

deleteFlagbooleanOptional

에이전트를 삭제하려면 True, 생성하려면 False

passwordstringOptional

새 에이전트를 만들 때 필요합니다. 비밀번호는 유효해야 합니다 (소문자, 대문자, 숫자, 비알파벳 문자 중 4개 중 3개를 포함해야 함).

localestringOptional

생성 중인 계정의 언어 설정. 두 글자 ISO 639-1 코드를 사용해 주세요.

permission_group_idstringOptional

에이전트에게 할당할 권한 그룹의 ID

permission_group_namestringOptional

에이전트에게 할당할 권한 그룹 이름

Responses

200

에이전트가 성공적으로 수정되었습니다.

application/json

400

잘못된 매개변수

application/json

404

에이전트를 찾을 수 없습니다.

application/json

post

/webapi/agent_management

HTTPcURLJavaScriptPython

POST /webapi/agent_management HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "email": "text",
  "deleteFlag": true,
  "password": "text",
  "locale": "text",
  "permission_group_id": "text",
  "permission_group_name": "text"
}

{
  "result": {
    "id": "text",
    "status": "text"
  }
}