跳转到内容

推理 API

其他

GET /v1/api-key

获取有关 API 密钥的信息,包括名称、状态、权限以及创建或修改此密钥的用户。

响应体

  • acls (array<string>, 必需) — 授权使用此 API 密钥的 ACL 列表,例如 `"api-key:endpoint:*"`, `"api-key:model:*"`。

  • api_key_blocked (boolean, 必需) — 表示 API 密钥是否被阻止。

  • api_key_disabled (boolean, 必需) — 表示 API 密钥是否被禁用。

  • api_key_id (string, 必需) — API 密钥的 ID。

  • create_time (string, 必需) — API 密钥的创建时间(Unix 时间戳)。

  • modified_by (string, 必需) — 最后修改 API 密钥的用户 ID。

  • modify_time (string, 必需) — API 密钥的最后修改时间(Unix 时间戳)。

  • name (string, 必需) — 用户指定的 API 密钥名称。

  • redacted_api_key (string, 必需) — 遮蔽的 API 密钥。

  • team_blocked (boolean, 必需) — 表示拥有此 API 密钥的团队是否被阻止。

  • team_id (string, 必需) — 拥有此 API 密钥的团队 ID。

  • user_id (string, 必需) — API 密钥所属的用户 ID。

响应示例:

json
{
  "redacted_api_key": "xai-...b14o",
  "user_id": "59fbe5f2-040b-46d5-8325-868bb8f23eb2",
  "name": "My API Key",
  "create_time": "2024-01-01T12:55:18.139305Z",
  "modify_time": "2024-08-28T17:20:12.343321Z",
  "modified_by": "3d38b4dc-4eb7-4785-ae26-c3fa8997ffc7",
  "team_id": "5ea6f6bd-7815-4b8a-9135-28b2d7ba6722",
  "acls": [
    "api-key:model:*",
    "api-key:endpoint:*"
  ],
  "api_key_id": "ae1e1841-4326-4b36-a8a9-8a1a7237db11",
  "team_blocked": false,
  "api_key_blocked": false,
  "api_key_disabled": false
}

POST /v1/tokenize-text

使用指定模型对文本进行分词

请求体

  • model (string) — 用于分词的模型。

  • text (string) — 要分词的文本内容。

  • user (string | null) — 可选的用户标识符。

响应体

  • token_ids (array<object>, 必需) — 令牌列表。

    • string_token (string, 必需) — 令牌的字符串。

    • token_bytes (array<integer>, 必需) — 构成令牌的字节。

    • token_id (integer, 必需) — 令牌在模型中的整数表示。

请求示例:

json
{
  "text": "Hello world!",
  "model": "latest"
}

响应示例:

json
{
  "token_ids": [
    {
      "token_id": 13902,
      "string_token": "Hello",
      "token_bytes": [
        72,
        101,
        108,
        108,
        111
      ]
    },
    {
      "token_id": 1749,
      "string_token": " world",
      "token_bytes": [
        32,
        119,
        111,
        114,
        108,
        100
      ]
    },
    {
      "token_id": 161,
      "string_token": "!",
      "token_bytes": [
        33
      ]
    }
  ]
}

本文档为 docs.x.ai 全站中文翻译,由 AI 自动翻译生成。代码示例请以原文为准。