Skip to main content
GET
/
v1
/
ais
/
{ai_id}
Get AI
curl --request GET \
  --url https://api.gbase.ai/v1/ais/{ai_id}
{
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "user": {
    "created_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "salt": "<string>",
    "picture": "<string>",
    "locale": "<string>",
    "corporate": false,
    "is_independent": false,
    "admin_overrides": "<unknown>",
    "dealer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "apis": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "function_call_name": "<string>",
      "openapi_url": "<string>",
      "server_url": "<string>",
      "path": "<string>",
      "method": "<string>",
      "header_authorization": "<unknown>",
      "function_type": "<string>",
      "function_status": "<string>",
      "share_status": "<string>",
      "user_id": "<string>",
      "function_call_description": "<string>",
      "matching_keywords": "<unknown>",
      "llm_sta": true,
      "body": "<unknown>",
      "auth_token_curl": "<unknown>",
      "body_required": "<unknown>",
      "request_explanation": "<string>"
    }
  ],
  "datasets": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "user_id": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "data_status": "init",
      "description": "<string>",
      "metadata": "<unknown>",
      "url_rules": "<unknown>",
      "organization_id": "<string>"
    }
  ],
  "questions": [
    {
      "question": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "question_type": "generator"
    }
  ],
  "file_count": 123,
  "configs": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discrible": "<string>",
  "subject_name": "<string>",
  "prompt": "<string>",
  "robot_type": "rag",
  "ai_type": "private",
  "ai_model": "file",
  "ai_status": "ready",
  "company_id": "<string>",
  "permission_type": "<string>",
  "clone_task_id": "<string>",
  "progress_percent": 123
}

Path Parameters

ai_id
string<uuid>
required

Response

Successful Response

Extended AIDetailOut with enterprise permission information

created_at
string<date-time>
required
read-only
name
string
required
Maximum string length: 100
user
User · object
required
apis
AgentFunctionCallApi · object[]
required
datasets
Dataset · object[]
required
questions
Question · object[]
required
file_count
integer
required
configs
Configs · object
required
id
string<uuid>
discrible
string | null
subject_name
string | null
prompt
string | null
robot_type
string
default:rag

RAG: rag
DIGITAL_HUMAN: digital_human
AGENT: agent
CATALOG_AGENT: catalog_agent
GENERAL_AGENT: general_agent

Maximum string length: 100
ai_type
string
default:private

DEFAULT: default
DEMO: demo
PUBLIC: public
PRIVATE: private
TRENDING: trending

Maximum string length: 20
ai_model
string
default:file

FILE: file
WEBSITE: website
DIGITAL_HUMAN: digital_human
AGENT: agent

Maximum string length: 20
ai_status
string
default:ready

INIT: init
READY: ready
FROZEN: frozen
CLONING_SOURCE: cloning_source
CLONING_TARGET: cloning_target
CLONING_FAILED: cloning_failed

Maximum string length: 20
company_id
string

Alias for organization_id for API compatibility

permission_type
string

User's permission type for this robot (OWNER, EDIT, VIEW).

clone_task_id
string

Active or most-recent clone task id when ai_status is in CLONING_*

progress_percent
integer

Clone progress percent (0-100) when ai_status is in CLONING_*