Meta
Retrieve a platform method
Read one platform method with its complete TypeScript declaration; public, no key required, not billed.
GET
/meta/v1/methods/{name}● SupportedRequest parameters
namestring必填path: Exact method name from the search results, for example `praxis.database.databases.tables.create`.
Returns
200
name comes from the search results and must match the method name exactly. The declaration is never truncated; copy field names and enum values from it. An unknown name returns 404 METHOD_NOT_FOUND whose hint lists up to three similar names.
Errors follow the problem+json format — see error codes
Response
HTTP 200
The method with its complete declaration.
application/json
| Name | Type | Description |
|---|---|---|
| name | string | Method name, for example `praxis.agent.agents.list`. |
| summary | string | One-line statement of what the method does. |
| description | string | Full guidance for the method from the API reference, including when to use it, limits and error behaviour. May be empty for methods documented only by summary. |
| http | string | HTTP verb the method sends. |
| path | string | Public API path template with `{param}` placeholders. |
| declaration | string | Complete TypeScript signature, `name(args): Promise<Result>`. `args` carries `path`, `query`, `headers` and `body` members exactly as declared. Never truncated. |
| parameters | array<object> | Path, query and header parameters of the operation. |
| parameters[].name | string | Parameter name as sent on the wire. |
| parameters[].in | string | Where the parameter goes, one of `path`, `query` or `header`; maps to the matching member of `args`. |
| parameters[].required | boolean | Whether the call is rejected when the parameter is missing. |
| parameters[].description | string | Meaning, format and allowed values of the parameter. |
| parameters[].type | string | TypeScript type of the parameter value. |
| request_body | object | Request body expectations; null when the method takes no body. |
| request_body.required | boolean | Whether `args.body` must be supplied. |
| request_body.description | string | What the body carries. |
| request_body.content_types | array<string> | Media types the body may use; the first is the default. |
| responses | array<object> | Documented responses, successful and failed. |
| responses[].status | string | HTTP status code or `default`. |
| responses[].description | string | What the response means and what to do next. |
| responses[].content_types | array<string> | Media types the response may use. |