LexAmpLexAmp

Lexamp API 文档

概述

Lexamp API 提供对我们法律 AI 服务的程序化访问。使用我们与 OpenAI 兼容的 API 构建强大的法律应用。

基础 URL

https://lexamp.net/

认证

所有 API 请求都需要使用 API 密钥进行认证。在 Authorization 请求头中包含您的 API 密钥:

Authorization: Bearer YOUR_API_KEY

您可以在开发者控制台中创建和管理 API 密钥。

安全最佳实践

  • 切勿在客户端代码或公共仓库中暴露 API 密钥
  • 使用环境变量存储密钥
  • 定期轮换密钥并撤销未使用的密钥
  • 为开发和生产环境使用不同的密钥

端点

列出模型

GET /v1/models

返回可用模型列表。

响应:

{
  "object": "list",
  "data": [
    {
      "id": "legal-rag",
      "object": "model",
      "created": 1700000000,
      "owned_by": "lexamp"
    }
  ]
}

对话补全

POST /v1/chat/completions

使用法律 AI 模型生成对话响应。

请求参数:

参数类型必需描述
modelstring模型 ID(使用 "legal-rag")
messagesarray消息对象数组
temperaturenumber采样温度(0-2,默认:1.0)
top_pnumber核采样(0-1,默认:1.0)
nnumber生成数量(1-128,默认:1)
streamboolean启用流式传输(默认:false)
stopstring/array停止序列
max_tokensnumber最大生成 token 数
presence_penaltynumber存在惩罚(-2 到 2,默认:0)
frequency_penaltynumber频率惩罚(-2 到 2,默认:0)
userstring用户标识符,用于会话管理

消息对象:

字段类型必需描述
rolestring角色:"system"、"user"、"assistant"、"tool"
contentstring消息内容
namestring可选名称标识符

请求示例:

{
  "model": "legal-rag",
  "messages": [
    {"role": "system", "content": "你是一个专业的法律助手。"},
    {"role": "user", "content": "什么是保密协议?"}
  ],
  "temperature": 0.7,
  "max_tokens": 1000
}

响应:

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1700000000,
  "model": "legal-rag",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "保密协议(NDA)是..."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 150,
    "total_tokens": 175
  }
}

重置会话

POST /v1/sessions/{session_id}/reset

重置对话会话以重新开始。

路径参数:

参数类型描述
session_idstring要重置的会话标识符

响应:

{
  "status": "success",
  "message": "Session abc123 reset"
}

健康检查

GET /health

检查 API 服务健康状态。

响应:

{
  "status": "healthy",
  "timestamp": "2024-01-01T12:00:00Z"
}

流式传输

当设置 stream: true 时,API 返回服务器发送事件(SSE)。每个事件包含响应的一部分:

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","created":1700000000,"model":"legal-rag","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","created":1700000000,"model":"legal-rag","choices":[{"index":0,"delta":{"content":"保"},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","created":1700000000,"model":"legal-rag","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

定价

项目价格
输入 token$8 / 百万 tokens
输出 token$25 / 百万 tokens
法律数据库搜索$0.005 / 次请求

速率限制

速率限制根据订阅层级而定:

层级请求/分钟用量
免费10100 次请求/月
入门60按量付费
专业300按量付费
企业自定义按量付费

错误处理

当发生错误时,API 返回包含错误代码和消息的 JSON 对象:

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "您已超出速率限制。",
    "type": "rate_limit_exceeded"
  }
}

HTTP 状态码

状态码描述
200成功
400错误请求 - 无效参数
401未授权 - 无效的 API 密钥
402需要付款 - 余额不足
403禁止访问 - 密钥未激活、已过期或 IP 不在白名单
429速率限制 - 请求过多或超出每日/每月限制
500服务器错误

错误代码

代码描述
INVALID_API_KEYAPI 密钥无效
INVALID_KEY_FORMATAPI 密钥格式不正确
AUTH_FAILED认证失败
KEY_INACTIVEAPI 密钥已停用
KEY_EXPIREDAPI 密钥已过期
ACCOUNT_INACTIVE账户未激活
PERMISSION_DENIEDAPI 密钥缺少所需权限
IP_NOT_ALLOWED请求 IP 不在白名单中
INSUFFICIENT_BALANCE账户余额不足
RATE_LIMIT_EXCEEDED超出每分钟速率限制
DAILY_LIMIT_EXCEEDED超出每日请求限制
MONTHLY_LIMIT_EXCEEDED超出每月请求限制

支持

如有问题,请联系我们的支持团队或访问开发者控制台