@atlanai/sdk 0.1.0

package/dist/raw/agent/apis/AgentsApi.d.ts

@@ -0,0 +1,258 @@
+/**
+ * Harness and agent catalog
+ * A `harness` is a tool a human drives; an `agent` is built with an `agent_framework` and run on an `agent_provider`. The gateway executes neither. This surface is the typed catalog for both — plus the `agent_framework` and `harness_vendor` catalogs, the `agent_provider` substrate, the `agent_environment` sandbox, and the `session`/`session_message` run history — the one agent run-trigger, live session reads (poll + SSE), and the access-controlled trace facade.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type AgentAgentArtifactView } from '../models/AgentAgentArtifactView';
+import { type AgentAgentCreate } from '../models/AgentAgentCreate';
+import { type AgentAgentIdentityRevealView } from '../models/AgentAgentIdentityRevealView';
+import { type AgentAgentIdentityStatusView } from '../models/AgentAgentIdentityStatusView';
+import { type AgentAgentPatch } from '../models/AgentAgentPatch';
+import { type AgentArtifactAggregateRequest } from '../models/AgentArtifactAggregateRequest';
+import { type AgentArtifactAggregateResponse } from '../models/AgentArtifactAggregateResponse';
+import { type AgentArtifactSearchRequest } from '../models/AgentArtifactSearchRequest';
+import { type AgentPageAgentArtifactView } from '../models/AgentPageAgentArtifactView';
+import { type AgentPageSessionArtifactView } from '../models/AgentPageSessionArtifactView';
+export interface AgentAggregateAgentsRequest {
+    agentArtifactAggregateRequest: AgentArtifactAggregateRequest;
+}
+export interface AgentArchiveAgentRequest {
+    agentId: string;
+}
+export interface AgentCreateAgentRequest {
+    agentAgentCreate: AgentAgentCreate;
+}
+export interface AgentDeleteAgentProfileImageRequest {
+    agentId: string;
+}
+export interface AgentGetAgentRequest {
+    agentId: string;
+}
+export interface AgentGetAgentProfileImageRequest {
+    agentId: string;
+    v?: string;
+}
+export interface AgentListAgentSessionsRequest {
+    agentId: string;
+    limit?: number;
+    offset?: number;
+}
+export interface AgentListAgentsRequest {
+    limit?: number;
+    offset?: number;
+    agentFrameworkId?: string;
+    modelId?: string;
+    agentProviderId?: string;
+    sort?: string;
+}
+export interface AgentPatchAgentRequest {
+    agentId: string;
+    agentAgentPatch: AgentAgentPatch;
+}
+export interface AgentRevokeAgentIdentityRequest {
+    agentId: string;
+}
+export interface AgentRotateAgentIdentityRequest {
+    agentId: string;
+}
+export interface AgentSearchAgentsRequest {
+    agentArtifactSearchRequest: AgentArtifactSearchRequest;
+}
+export interface AgentUploadAgentProfileImageRequest {
+    agentId: string;
+    body: Blob;
+}
+/**
+ *
+ */
+export declare class AgentsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for agentAggregateAgents without sending the request
+     */
+    agentAggregateAgentsRequestOpts(requestParameters: AgentAggregateAgentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Group-and-measure over agents — e.g. `group_by: [{field: sync_state}]` to see how many agents have never been pushed, or by `agent_framework_id` for the framework mix. Dimensions are common artifact fields or the kind\'s filterable fields; `page.total` is the distinct-group count.
+     * Aggregate agents
+     */
+    agentAggregateAgentsRaw(requestParameters: AgentAggregateAgentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentArtifactAggregateResponse>>;
+    /**
+     * Group-and-measure over agents — e.g. `group_by: [{field: sync_state}]` to see how many agents have never been pushed, or by `agent_framework_id` for the framework mix. Dimensions are common artifact fields or the kind\'s filterable fields; `page.total` is the distinct-group count.
+     * Aggregate agents
+     */
+    agentAggregateAgents(requestParameters: AgentAggregateAgentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentArtifactAggregateResponse>;
+    /**
+     * Creates request options for agentArchiveAgent without sending the request
+     */
+    agentArchiveAgentRequestOpts(requestParameters: AgentArchiveAgentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Soft-delete the agent. The service archives its remote agent and credential vault at the provider (best-effort) and cascades its `session` history. Recoverable on the gateway side; the remote teardown is not. The seeded system agent cannot be archived.
+     * Archive an agent
+     */
+    agentArchiveAgentRaw(requestParameters: AgentArchiveAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentArtifactView>>;
+    /**
+     * Soft-delete the agent. The service archives its remote agent and credential vault at the provider (best-effort) and cascades its `session` history. Recoverable on the gateway side; the remote teardown is not. The seeded system agent cannot be archived.
+     * Archive an agent
+     */
+    agentArchiveAgent(requestParameters: AgentArchiveAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentArtifactView>;
+    /**
+     * Creates request options for agentCreateAgent without sending the request
+     */
+    agentCreateAgentRequestOpts(requestParameters: AgentCreateAgentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create an `agent` — a framework-built agent carrying its own spec (instructions, model, tool refs, step budget). This is a catalogue entry: the gateway does not execute the agent and does not dial its `agent_provider`, which records only *where* the customer runs it. Whoever runs it reports each run back as a `session` (`POST /sessions`). A non-system agent is **identity-bearing** — the gateway provisions it a Control-Plane machine identity at create, so a remote run can act as itself. The remote columns (`remote_agent_id`, `sync_state`, …) are server-managed and not accepted here.
+     * Create an agent
+     */
+    agentCreateAgentRaw(requestParameters: AgentCreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentArtifactView>>;
+    /**
+     * Create an `agent` — a framework-built agent carrying its own spec (instructions, model, tool refs, step budget). This is a catalogue entry: the gateway does not execute the agent and does not dial its `agent_provider`, which records only *where* the customer runs it. Whoever runs it reports each run back as a `session` (`POST /sessions`). A non-system agent is **identity-bearing** — the gateway provisions it a Control-Plane machine identity at create, so a remote run can act as itself. The remote columns (`remote_agent_id`, `sync_state`, …) are server-managed and not accepted here.
+     * Create an agent
+     */
+    agentCreateAgent(requestParameters: AgentCreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentArtifactView>;
+    /**
+     * Creates request options for agentDeleteAgentProfileImage without sending the request
+     */
+    agentDeleteAgentProfileImageRequestOpts(requestParameters: AgentDeleteAgentProfileImageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Clear the agent\'s picture, so `profile_image_url` disappears from its view and the read route answers `404`. A console falls back to whatever it draws for an agent without one. Idempotent: an agent that has no image returns `200` unchanged.  The stored bytes are **not** deleted. They are content-addressed and may be shared with another agent that uploaded the same picture, so reclaiming them is a sweep over every reference rather than a per-agent delete.
+     * Remove an agent\'s profile image
+     */
+    agentDeleteAgentProfileImageRaw(requestParameters: AgentDeleteAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentArtifactView>>;
+    /**
+     * Clear the agent\'s picture, so `profile_image_url` disappears from its view and the read route answers `404`. A console falls back to whatever it draws for an agent without one. Idempotent: an agent that has no image returns `200` unchanged.  The stored bytes are **not** deleted. They are content-addressed and may be shared with another agent that uploaded the same picture, so reclaiming them is a sweep over every reference rather than a per-agent delete.
+     * Remove an agent\'s profile image
+     */
+    agentDeleteAgentProfileImage(requestParameters: AgentDeleteAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentArtifactView>;
+    /**
+     * Creates request options for agentGetAgent without sending the request
+     */
+    agentGetAgentRequestOpts(requestParameters: AgentGetAgentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Read one agent with its full typed metadata — the spec plus the server-managed remote registration (`remote_agent_id`, `remote_version_ordinal`, `sync_state`, `sync_error`), which is how a client tells a never-run agent from a pushed one. The gateway triggers no runs; read the history reported for this agent with `GET /agents/{agent_id}/sessions`.
+     * Get an agent
+     */
+    agentGetAgentRaw(requestParameters: AgentGetAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentArtifactView>>;
+    /**
+     * Read one agent with its full typed metadata — the spec plus the server-managed remote registration (`remote_agent_id`, `remote_version_ordinal`, `sync_state`, `sync_error`), which is how a client tells a never-run agent from a pushed one. The gateway triggers no runs; read the history reported for this agent with `GET /agents/{agent_id}/sessions`.
+     * Get an agent
+     */
+    agentGetAgent(requestParameters: AgentGetAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentArtifactView>;
+    /**
+     * Creates request options for agentGetAgentProfileImage without sending the request
+     */
+    agentGetAgentProfileImageRequestOpts(requestParameters: AgentGetAgentProfileImageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the agent\'s picture as raw image bytes, with the media type it was stored as. This is the address `profile_image_url` on the agent points at, and it is what a client renders.  `profile_image_url` embeds the image\'s content digest as `?v=`, so the address changes exactly when the picture does and a client can cache against it rather than a timer. The `v` parameter is a cache key only and is **ignored by the server**, so a stale one still returns the current image.  `404` when the agent has no picture, so a client can treat \"no image\" and \"no agent\" the same way: fall back to whatever it draws for an agent without one.
+     * Get an agent\'s profile image
+     */
+    agentGetAgentProfileImageRaw(requestParameters: AgentGetAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Return the agent\'s picture as raw image bytes, with the media type it was stored as. This is the address `profile_image_url` on the agent points at, and it is what a client renders.  `profile_image_url` embeds the image\'s content digest as `?v=`, so the address changes exactly when the picture does and a client can cache against it rather than a timer. The `v` parameter is a cache key only and is **ignored by the server**, so a stale one still returns the current image.  `404` when the agent has no picture, so a client can treat \"no image\" and \"no agent\" the same way: fall back to whatever it draws for an agent without one.
+     * Get an agent\'s profile image
+     */
+    agentGetAgentProfileImage(requestParameters: AgentGetAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for agentListAgentSessions without sending the request
+     */
+    agentListAgentSessionsRequestOpts(requestParameters: AgentListAgentSessionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The `session` artifacts whose subject is this agent, newest first, in the `{items, page}` envelope. Page with `?limit` (default 50, max 500) + `?offset`. Rich filtering by `session_status` and `agent_provider_type` is available on `GET /sessions`.
+     * List an agent\'s sessions
+     */
+    agentListAgentSessionsRaw(requestParameters: AgentListAgentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentPageSessionArtifactView>>;
+    /**
+     * The `session` artifacts whose subject is this agent, newest first, in the `{items, page}` envelope. Page with `?limit` (default 50, max 500) + `?offset`. Rich filtering by `session_status` and `agent_provider_type` is available on `GET /sessions`.
+     * List an agent\'s sessions
+     */
+    agentListAgentSessions(requestParameters: AgentListAgentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentPageSessionArtifactView>;
+    /**
+     * Creates request options for agentListAgents without sending the request
+     */
+    agentListAgentsRequestOpts(requestParameters: AgentListAgentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Page the account\'s agents, each carrying its typed metadata including the server-managed remote-sync state. `agent_framework_id`, `model_id`, `agent_provider_id`, and `sync_state` filter on the kind\'s filterable fields. The seeded system agent is excluded.
+     * List agents
+     */
+    agentListAgentsRaw(requestParameters: AgentListAgentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentPageAgentArtifactView>>;
+    /**
+     * Page the account\'s agents, each carrying its typed metadata including the server-managed remote-sync state. `agent_framework_id`, `model_id`, `agent_provider_id`, and `sync_state` filter on the kind\'s filterable fields. The seeded system agent is excluded.
+     * List agents
+     */
+    agentListAgents(requestParameters?: AgentListAgentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentPageAgentArtifactView>;
+    /**
+     * Creates request options for agentPatchAgent without sending the request
+     */
+    agentPatchAgentRequestOpts(requestParameters: AgentPatchAgentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Partially update an agent by RFC 7396 JSON Merge Patch. Editing any spec field (`instructions`, `model_id`, `tools`, `max_step_count`) changes the agent\'s spec hash, so the next run-trigger pushes a **new remote version** instead of reusing the current one — the edit itself performs no provider I/O. The server-managed remote columns are restored from the stored row on every update, and the seeded system agent\'s spec is pinned. Send `If-Match` with a prior read\'s `content_hash_hex` to make the write conditional.
+     * Update an agent
+     */
+    agentPatchAgentRaw(requestParameters: AgentPatchAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentArtifactView>>;
+    /**
+     * Partially update an agent by RFC 7396 JSON Merge Patch. Editing any spec field (`instructions`, `model_id`, `tools`, `max_step_count`) changes the agent\'s spec hash, so the next run-trigger pushes a **new remote version** instead of reusing the current one — the edit itself performs no provider I/O. The server-managed remote columns are restored from the stored row on every update, and the seeded system agent\'s spec is pinned. Send `If-Match` with a prior read\'s `content_hash_hex` to make the write conditional.
+     * Update an agent
+     */
+    agentPatchAgent(requestParameters: AgentPatchAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentArtifactView>;
+    /**
+     * Creates request options for agentRevokeAgentIdentity without sending the request
+     */
+    agentRevokeAgentIdentityRequestOpts(requestParameters: AgentRevokeAgentIdentityRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Terminally revoke the agent\'s machine identity: its identity client is archived and the agent is marked revoked, so a token it still holds is rejected on its next request rather than when a cache expires. **Irreversible** — there is no re-enable, and a new credential means a new agent. Idempotent: revoking an already-revoked identity returns `200`. The agent artifact itself is untouched; archive it separately. Requires `update` on the agent\'s workspace.
+     * Revoke an agent\'s API key
+     */
+    agentRevokeAgentIdentityRaw(requestParameters: AgentRevokeAgentIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentIdentityStatusView>>;
+    /**
+     * Terminally revoke the agent\'s machine identity: its identity client is archived and the agent is marked revoked, so a token it still holds is rejected on its next request rather than when a cache expires. **Irreversible** — there is no re-enable, and a new credential means a new agent. Idempotent: revoking an already-revoked identity returns `200`. The agent artifact itself is untouched; archive it separately. Requires `update` on the agent\'s workspace.
+     * Revoke an agent\'s API key
+     */
+    agentRevokeAgentIdentity(requestParameters: AgentRevokeAgentIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentIdentityStatusView>;
+    /**
+     * Creates request options for agentRotateAgentIdentity without sending the request
+     */
+    agentRotateAgentIdentityRequestOpts(requestParameters: AgentRotateAgentIdentityRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Issue a fresh credential for the agent\'s machine identity and invalidate the previous one. The material is revealed **exactly once, in this response** — the gateway stores none of it, so there is no endpoint that can return it again. Any runner still holding the old key stops authenticating immediately, so rotate when you are ready to redeploy it. Requires `update` on the agent\'s workspace.
+     * Rotate an agent\'s API key
+     */
+    agentRotateAgentIdentityRaw(requestParameters: AgentRotateAgentIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentIdentityRevealView>>;
+    /**
+     * Issue a fresh credential for the agent\'s machine identity and invalidate the previous one. The material is revealed **exactly once, in this response** — the gateway stores none of it, so there is no endpoint that can return it again. Any runner still holding the old key stops authenticating immediately, so rotate when you are ready to redeploy it. Requires `update` on the agent\'s workspace.
+     * Rotate an agent\'s API key
+     */
+    agentRotateAgentIdentity(requestParameters: AgentRotateAgentIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentIdentityRevealView>;
+    /**
+     * Creates request options for agentSearchAgents without sending the request
+     */
+    agentSearchAgentsRequestOpts(requestParameters: AgentSearchAgentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Discovery over agents. `instructions` is a searchable column, so `fts` matches an agent\'s system prompt as well as its name and description; `vector` and `hybrid` embed `query` server-side. Results are summary-only and therefore carry no `metadata`.
+     * Search agents
+     */
+    agentSearchAgentsRaw(requestParameters: AgentSearchAgentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentPageAgentArtifactView>>;
+    /**
+     * Discovery over agents. `instructions` is a searchable column, so `fts` matches an agent\'s system prompt as well as its name and description; `vector` and `hybrid` embed `query` server-side. Results are summary-only and therefore carry no `metadata`.
+     * Search agents
+     */
+    agentSearchAgents(requestParameters: AgentSearchAgentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentPageAgentArtifactView>;
+    /**
+     * Creates request options for agentUploadAgentProfileImage without sending the request
+     */
+    agentUploadAgentProfileImageRequestOpts(requestParameters: AgentUploadAgentProfileImageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Store the picture a console renders for this agent, replacing any current one. Send the **raw image bytes** as the request body: a PNG, JPEG, WebP or GIF, at most 2 MiB. The format is read from the bytes, so `Content-Type` is optional — send `application/octet-stream`, or omit it, and the type is detected. A specific type that disagrees with the bytes is rejected rather than corrected. SVG is not accepted, because it is a script-bearing document rather than an image.  The gateway owns the bytes: read them back with `GET /agents/{agent_id}/profile-image`, whose path this response reports as `profile_image_url`. Uploading again replaces the image at the same address.
+     * Upload an agent\'s profile image
+     */
+    agentUploadAgentProfileImageRaw(requestParameters: AgentUploadAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentAgentArtifactView>>;
+    /**
+     * Store the picture a console renders for this agent, replacing any current one. Send the **raw image bytes** as the request body: a PNG, JPEG, WebP or GIF, at most 2 MiB. The format is read from the bytes, so `Content-Type` is optional — send `application/octet-stream`, or omit it, and the type is detected. A specific type that disagrees with the bytes is rejected rather than corrected. SVG is not accepted, because it is a script-bearing document rather than an image.  The gateway owns the bytes: read them back with `GET /agents/{agent_id}/profile-image`, whose path this response reports as `profile_image_url`. Uploading again replaces the image at the same address.
+     * Upload an agent\'s profile image
+     */
+    agentUploadAgentProfileImage(requestParameters: AgentUploadAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentAgentArtifactView>;
+}