自动化
搜索自动化定义
按名称搜索可见目标，按名称升序分页。
按名称搜索可见目标，按名称升序分页；默认排除归档目标，可筛选已发布的脚本和工作流。
GET /automation/v1/targets
鉴权
Authorization: Bearer $PRAXIS_API_KEY
请求字段
| 参数 | 类型 | 说明 |
|---|---|---|
| query: q | string | 可选；不区分大小写，按 ns/name 或说明的字面子串匹配。 |
| query: kind | "action" / "script" / "workflow"[] | 可选；action、script 或 workflow；省略返回全部。 多个值以逗号分隔，匹配任一值。 minItems: 1 |
| query: limit | integer | 可选；每页条数，整数 1–100，默认 25。 minimum: 1；maximum: 100 |
| query: labels | object | 可选；按标签过滤，使用 labels[k]=v；同键逗号多值取任一，不同键同时满足。 |
| query: created_at[gte] | string | 可选；创建时间下界，包含边界；使用带时区的 ISO 8601 时间。 format: "date-time" |
| query: created_at[lte] | string | 可选；创建时间上界，包含边界；使用带时区的 ISO 8601 时间。 format: "date-time" |
| query: cursor | string | 可选；上一页的 next_cursor；翻页时保留原筛选条件。 |
| query: archived | boolean | 可选；默认 false，仅返回未归档目标；true 仅返回已归档目标。 default: false |
| query: published | boolean | 可选；true 仅返回有已发布版本的编排；动作始终可用。 |
示例
curl --fail-with-body -X GET "https://api.deepraxis.ai/automation/v1/targets" \
-H "Authorization: Bearer $PRAXIS_API_KEY" \
--get \
--data-urlencode "q=sample-" \
--data-urlencode "limit=1"import { createAutomationClient } from '@deepractice-ai/praxis-sdk/automation';
function env(name: string): string {
const value = process.env[name];
if (!value) throw new Error(`Set ${name}`);
return value;
}
const automation = createAutomationClient({
apiKey: env('PRAXIS_API_KEY'),
baseUrl: 'https://api.deepraxis.ai',
maxRetries: 0,
timeoutMs: 90_000,
});
const result = await automation.targets.list({
"query": {
"q": "sample-",
"limit": 1
}
});
console.log(result);响应
HTTP 200
Success
application/json
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object[] | 必填 / 必有；本页的目标搜索结果（动作、脚本、工作流），按相关度和创建时间排列。 |
| data[].kind | "action" / "script" / "workflow" | 必填 / 必有；目标类型。action 为动作；script 为脚本；workflow 为工作流。 |
| data[].namespace | string | 必填 / 必有；目标命名空间。 |
| data[].name | string | 必填 / 必有；目标名字。 |
| data[].description | string | 必填 / 必有；目标的说明文字。 |
| data[].latest_version | null / string | 必填 / 必有；latest 标签指向的版本号；动作或尚未发布时为 null。 |
| data[].archived | boolean | 必填 / 必有；true 表示目标已归档，不能再被运行。 |
| next_cursor | string / null | 必填 / 必有；下一页游标，原样传给 cursor 参数并保持原查询条件；没有更多页为 null。接口不返回总数。 |
实测响应
HTTP 200
{
"data": [
{
"kind": "action",
"namespace": "docs-samples",
"name": "sample-action-1791867412840-b05e8a",
"description": "",
"latest_version": null,
"archived": false
}
],
"next_cursor": "WyJbXCJ0YXJnZXRzXCIsXCJ0bnRfM2E5NzU5ODY0Y2NiNGUwMFwiLHtcInFcIjpcInNhbXBsZS1cIn1dIiwiZG9jcy1zYW1wbGVzL3NhbXBsZS1hY3Rpb24tMTc5MTg2NzQxMjg0MC1iMDVlOGEiLCJmdW5jdGlvbjphY3RfMDBtdjY3bG96NGZlNGYyN2JkZjg5MzQ2Yzg4NWIzYTI4YjIwMzhjMDkxIl0="
}错误码
| HTTP | 错误码与说明 |
|---|---|
| 400 | INVALID_PARAMS：请求参数、路径、游标或请求体格式无效。 |
| default | RFC 9457 automation problem. 429 includes Retry-After. |
鉴权错误与通用错误 · 排查时保留响应头 X-Request-Id。