@reminix/sdk 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/LICENSE +201 -0
- package/README.md +358 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +183 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +183 -0
- package/client.d.ts.map +1 -0
- package/client.js +464 -0
- package/client.js.map +1 -0
- package/client.mjs +460 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +137 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/agents.d.mts +203 -0
- package/resources/agents.d.mts.map +1 -0
- package/resources/agents.d.ts +203 -0
- package/resources/agents.d.ts.map +1 -0
- package/resources/agents.js +90 -0
- package/resources/agents.js.map +1 -0
- package/resources/agents.mjs +86 -0
- package/resources/agents.mjs.map +1 -0
- package/resources/index.d.mts +3 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +3 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +9 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +4 -0
- package/resources/index.mjs.map +1 -0
- package/resources/project.d.mts +49 -0
- package/resources/project.d.mts.map +1 -0
- package/resources/project.d.ts +49 -0
- package/resources/project.d.ts.map +1 -0
- package/resources/project.js +25 -0
- package/resources/project.js.map +1 -0
- package/resources/project.mjs +21 -0
- package/resources/project.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +745 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/agents.ts +239 -0
- package/src/resources/index.ts +11 -0
- package/src/resources/project.ts +60 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class Agents extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Have a conversational interaction with an agent. This endpoint maintains
|
|
7
|
+
* conversation context through the messages array, allowing for multi-turn
|
|
8
|
+
* conversations.
|
|
9
|
+
*
|
|
10
|
+
* **Timeout:** Chat requests have a 60-second timeout. If the agent takes longer
|
|
11
|
+
* to respond, you will receive a 504 Gateway Timeout error. For long-running
|
|
12
|
+
* conversations, consider using streaming mode which does not have the same
|
|
13
|
+
* timeout constraints.
|
|
14
|
+
*
|
|
15
|
+
* **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
|
|
16
|
+
* with a unique value (e.g., UUID) to ensure duplicate requests return the same
|
|
17
|
+
* response. Keys are valid for 24 hours. Streaming responses are not cached.
|
|
18
|
+
*
|
|
19
|
+
* **Use cases:**
|
|
20
|
+
*
|
|
21
|
+
* - Customer support chatbots
|
|
22
|
+
* - AI assistants with memory
|
|
23
|
+
* - Multi-step question answering
|
|
24
|
+
* - Conversational agents that need context
|
|
25
|
+
*
|
|
26
|
+
* **Message format:** Follows OpenAI-compliant message structure with support for:
|
|
27
|
+
*
|
|
28
|
+
* - `system`, `user`, `assistant`, and `tool` roles
|
|
29
|
+
* - Multimodal content (text + images)
|
|
30
|
+
* - Tool/function calling
|
|
31
|
+
*
|
|
32
|
+
* **Streaming:** Set `stream: true` in the request body to receive Server-Sent
|
|
33
|
+
* Events (SSE) stream with incremental chunks. Perfect for ChatGPT-like real-time
|
|
34
|
+
* chat interfaces.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const response = await client.agents.chat('name', {
|
|
39
|
+
* messages: [
|
|
40
|
+
* { role: 'user', content: 'What is the weather today?' },
|
|
41
|
+
* ],
|
|
42
|
+
* });
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
chat(name: string, body: AgentChatParams, options?: RequestOptions): APIPromise<AgentChatResponse>;
|
|
46
|
+
/**
|
|
47
|
+
* Execute a one-shot task with an agent. This endpoint is designed for
|
|
48
|
+
* task-oriented operations where you provide input and receive a complete output.
|
|
49
|
+
*
|
|
50
|
+
* **Timeout:** Agent invocations have a 60-second timeout. If the agent takes
|
|
51
|
+
* longer to respond, you will receive a 504 Gateway Timeout error. For
|
|
52
|
+
* long-running tasks, consider using streaming mode which does not have the same
|
|
53
|
+
* timeout constraints.
|
|
54
|
+
*
|
|
55
|
+
* **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
|
|
56
|
+
* with a unique value (e.g., UUID) to ensure duplicate requests return the same
|
|
57
|
+
* response. Keys are valid for 24 hours. Streaming responses are not cached.
|
|
58
|
+
*
|
|
59
|
+
* **Use cases:**
|
|
60
|
+
*
|
|
61
|
+
* - Data analysis and processing
|
|
62
|
+
* - Content generation (with streaming for long outputs)
|
|
63
|
+
* - One-time operations that don't require conversation history
|
|
64
|
+
* - API-like operations
|
|
65
|
+
*
|
|
66
|
+
* **Streaming:** Set `stream: true` in the request body to receive Server-Sent
|
|
67
|
+
* Events (SSE) stream with incremental chunks. Useful for long-running tasks or
|
|
68
|
+
* real-time progress updates.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const response = await client.agents.invoke('name', {
|
|
73
|
+
* input: {
|
|
74
|
+
* task: 'analyze this data',
|
|
75
|
+
* data: { value: 123, items: ['a', 'b', 'c'] },
|
|
76
|
+
* },
|
|
77
|
+
* });
|
|
78
|
+
* ```
|
|
79
|
+
*/
|
|
80
|
+
invoke(name: string, body: AgentInvokeParams, options?: RequestOptions): APIPromise<AgentInvokeResponse>;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Optional request context passed to the agent handler.
|
|
84
|
+
*/
|
|
85
|
+
export interface Context {
|
|
86
|
+
/**
|
|
87
|
+
* ID to track multi-turn conversations
|
|
88
|
+
*/
|
|
89
|
+
conversation_id?: string;
|
|
90
|
+
/**
|
|
91
|
+
* Additional custom context fields
|
|
92
|
+
*/
|
|
93
|
+
custom?: {
|
|
94
|
+
[key: string]: unknown;
|
|
95
|
+
};
|
|
96
|
+
/**
|
|
97
|
+
* ID of the user making the request
|
|
98
|
+
*/
|
|
99
|
+
user_id?: string;
|
|
100
|
+
}
|
|
101
|
+
export interface AgentChatResponse {
|
|
102
|
+
/**
|
|
103
|
+
* Assistant message response
|
|
104
|
+
*/
|
|
105
|
+
message: AgentChatResponse.Message;
|
|
106
|
+
}
|
|
107
|
+
export declare namespace AgentChatResponse {
|
|
108
|
+
/**
|
|
109
|
+
* Assistant message response
|
|
110
|
+
*/
|
|
111
|
+
interface Message {
|
|
112
|
+
content: string | Array<unknown> | null;
|
|
113
|
+
role: 'assistant';
|
|
114
|
+
tool_calls?: Array<Message.ToolCall>;
|
|
115
|
+
}
|
|
116
|
+
namespace Message {
|
|
117
|
+
interface ToolCall {
|
|
118
|
+
id: string;
|
|
119
|
+
function: ToolCall.Function;
|
|
120
|
+
type: 'function';
|
|
121
|
+
}
|
|
122
|
+
namespace ToolCall {
|
|
123
|
+
interface Function {
|
|
124
|
+
arguments: string;
|
|
125
|
+
name: string;
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
export interface AgentInvokeResponse {
|
|
131
|
+
/**
|
|
132
|
+
* Output from the agent. Structure depends on agent implementation.
|
|
133
|
+
*/
|
|
134
|
+
output?: unknown;
|
|
135
|
+
}
|
|
136
|
+
export interface AgentChatParams {
|
|
137
|
+
/**
|
|
138
|
+
* Conversation history. Must include at least one message.
|
|
139
|
+
*/
|
|
140
|
+
messages: Array<AgentChatParams.Message>;
|
|
141
|
+
/**
|
|
142
|
+
* Optional request context passed to the agent handler.
|
|
143
|
+
*/
|
|
144
|
+
context?: Context;
|
|
145
|
+
/**
|
|
146
|
+
* Whether to stream the response as SSE.
|
|
147
|
+
*/
|
|
148
|
+
stream?: boolean;
|
|
149
|
+
}
|
|
150
|
+
export declare namespace AgentChatParams {
|
|
151
|
+
interface Message {
|
|
152
|
+
/**
|
|
153
|
+
* Message content. Can be string, array (multimodal), or object (tool).
|
|
154
|
+
*/
|
|
155
|
+
content: string | Array<Message.UnionMember1> | {
|
|
156
|
+
[key: string]: unknown;
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* Message role
|
|
160
|
+
*/
|
|
161
|
+
role: 'system' | 'user' | 'assistant' | 'tool';
|
|
162
|
+
/**
|
|
163
|
+
* Tool name (required when role is "tool")
|
|
164
|
+
*/
|
|
165
|
+
name?: string;
|
|
166
|
+
/**
|
|
167
|
+
* Tool call ID (for tool role)
|
|
168
|
+
*/
|
|
169
|
+
tool_call_id?: string;
|
|
170
|
+
}
|
|
171
|
+
namespace Message {
|
|
172
|
+
interface UnionMember1 {
|
|
173
|
+
type: 'text' | 'image_url';
|
|
174
|
+
image_url?: UnionMember1.ImageURL;
|
|
175
|
+
text?: string;
|
|
176
|
+
}
|
|
177
|
+
namespace UnionMember1 {
|
|
178
|
+
interface ImageURL {
|
|
179
|
+
url: string;
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
export interface AgentInvokeParams {
|
|
185
|
+
/**
|
|
186
|
+
* Input data for the agent. Structure depends on agent implementation.
|
|
187
|
+
*/
|
|
188
|
+
input: {
|
|
189
|
+
[key: string]: unknown;
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* Optional request context passed to the agent handler.
|
|
193
|
+
*/
|
|
194
|
+
context?: Context;
|
|
195
|
+
/**
|
|
196
|
+
* Whether to stream the response as SSE.
|
|
197
|
+
*/
|
|
198
|
+
stream?: boolean;
|
|
199
|
+
}
|
|
200
|
+
export declare namespace Agents {
|
|
201
|
+
export { type Context as Context, type AgentChatResponse as AgentChatResponse, type AgentInvokeResponse as AgentInvokeResponse, type AgentChatParams as AgentChatParams, type AgentInvokeParams as AgentInvokeParams, };
|
|
202
|
+
}
|
|
203
|
+
//# sourceMappingURL=agents.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../src/resources/agents.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGzG;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC;CACpC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,OAAO;QACtB,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QAExC,IAAI,EAAE,WAAW,CAAC;QAElB,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;KACtC;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,QAAQ;YACvB,EAAE,EAAE,MAAM,CAAC;YAEX,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;YAE5B,IAAI,EAAE,UAAU,CAAC;SAClB;QAED,UAAiB,QAAQ,CAAC;YACxB,UAAiB,QAAQ;gBACvB,SAAS,EAAE,MAAM,CAAC;gBAElB,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,OAAO;QACtB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3E;;WAEG;QACH,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;QAE/C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,YAAY;YAC3B,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;YAE3B,SAAS,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC;YAElC,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,YAAY,CAAC;YAC5B,UAAiB,QAAQ;gBACvB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Agents = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const path_1 = require("../internal/utils/path.js");
|
|
7
|
+
class Agents extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Have a conversational interaction with an agent. This endpoint maintains
|
|
10
|
+
* conversation context through the messages array, allowing for multi-turn
|
|
11
|
+
* conversations.
|
|
12
|
+
*
|
|
13
|
+
* **Timeout:** Chat requests have a 60-second timeout. If the agent takes longer
|
|
14
|
+
* to respond, you will receive a 504 Gateway Timeout error. For long-running
|
|
15
|
+
* conversations, consider using streaming mode which does not have the same
|
|
16
|
+
* timeout constraints.
|
|
17
|
+
*
|
|
18
|
+
* **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
|
|
19
|
+
* with a unique value (e.g., UUID) to ensure duplicate requests return the same
|
|
20
|
+
* response. Keys are valid for 24 hours. Streaming responses are not cached.
|
|
21
|
+
*
|
|
22
|
+
* **Use cases:**
|
|
23
|
+
*
|
|
24
|
+
* - Customer support chatbots
|
|
25
|
+
* - AI assistants with memory
|
|
26
|
+
* - Multi-step question answering
|
|
27
|
+
* - Conversational agents that need context
|
|
28
|
+
*
|
|
29
|
+
* **Message format:** Follows OpenAI-compliant message structure with support for:
|
|
30
|
+
*
|
|
31
|
+
* - `system`, `user`, `assistant`, and `tool` roles
|
|
32
|
+
* - Multimodal content (text + images)
|
|
33
|
+
* - Tool/function calling
|
|
34
|
+
*
|
|
35
|
+
* **Streaming:** Set `stream: true` in the request body to receive Server-Sent
|
|
36
|
+
* Events (SSE) stream with incremental chunks. Perfect for ChatGPT-like real-time
|
|
37
|
+
* chat interfaces.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* const response = await client.agents.chat('name', {
|
|
42
|
+
* messages: [
|
|
43
|
+
* { role: 'user', content: 'What is the weather today?' },
|
|
44
|
+
* ],
|
|
45
|
+
* });
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
chat(name, body, options) {
|
|
49
|
+
return this._client.post((0, path_1.path) `/agents/${name}/chat`, { body, ...options });
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Execute a one-shot task with an agent. This endpoint is designed for
|
|
53
|
+
* task-oriented operations where you provide input and receive a complete output.
|
|
54
|
+
*
|
|
55
|
+
* **Timeout:** Agent invocations have a 60-second timeout. If the agent takes
|
|
56
|
+
* longer to respond, you will receive a 504 Gateway Timeout error. For
|
|
57
|
+
* long-running tasks, consider using streaming mode which does not have the same
|
|
58
|
+
* timeout constraints.
|
|
59
|
+
*
|
|
60
|
+
* **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
|
|
61
|
+
* with a unique value (e.g., UUID) to ensure duplicate requests return the same
|
|
62
|
+
* response. Keys are valid for 24 hours. Streaming responses are not cached.
|
|
63
|
+
*
|
|
64
|
+
* **Use cases:**
|
|
65
|
+
*
|
|
66
|
+
* - Data analysis and processing
|
|
67
|
+
* - Content generation (with streaming for long outputs)
|
|
68
|
+
* - One-time operations that don't require conversation history
|
|
69
|
+
* - API-like operations
|
|
70
|
+
*
|
|
71
|
+
* **Streaming:** Set `stream: true` in the request body to receive Server-Sent
|
|
72
|
+
* Events (SSE) stream with incremental chunks. Useful for long-running tasks or
|
|
73
|
+
* real-time progress updates.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* const response = await client.agents.invoke('name', {
|
|
78
|
+
* input: {
|
|
79
|
+
* task: 'analyze this data',
|
|
80
|
+
* data: { value: 123, items: ['a', 'b', 'c'] },
|
|
81
|
+
* },
|
|
82
|
+
* });
|
|
83
|
+
* ```
|
|
84
|
+
*/
|
|
85
|
+
invoke(name, body, options) {
|
|
86
|
+
return this._client.post((0, path_1.path) `/agents/${name}/invoke`, { body, ...options });
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
exports.Agents = Agents;
|
|
90
|
+
//# sourceMappingURL=agents.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"agents.js","sourceRoot":"","sources":["../src/resources/agents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,IAAI,CAAC,IAAY,EAAE,IAAqB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,WAAW,IAAI,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,IAAY,EAAE,IAAuB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,WAAW,IAAI,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAlFD,wBAkFC"}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { path } from "../internal/utils/path.mjs";
|
|
4
|
+
export class Agents extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Have a conversational interaction with an agent. This endpoint maintains
|
|
7
|
+
* conversation context through the messages array, allowing for multi-turn
|
|
8
|
+
* conversations.
|
|
9
|
+
*
|
|
10
|
+
* **Timeout:** Chat requests have a 60-second timeout. If the agent takes longer
|
|
11
|
+
* to respond, you will receive a 504 Gateway Timeout error. For long-running
|
|
12
|
+
* conversations, consider using streaming mode which does not have the same
|
|
13
|
+
* timeout constraints.
|
|
14
|
+
*
|
|
15
|
+
* **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
|
|
16
|
+
* with a unique value (e.g., UUID) to ensure duplicate requests return the same
|
|
17
|
+
* response. Keys are valid for 24 hours. Streaming responses are not cached.
|
|
18
|
+
*
|
|
19
|
+
* **Use cases:**
|
|
20
|
+
*
|
|
21
|
+
* - Customer support chatbots
|
|
22
|
+
* - AI assistants with memory
|
|
23
|
+
* - Multi-step question answering
|
|
24
|
+
* - Conversational agents that need context
|
|
25
|
+
*
|
|
26
|
+
* **Message format:** Follows OpenAI-compliant message structure with support for:
|
|
27
|
+
*
|
|
28
|
+
* - `system`, `user`, `assistant`, and `tool` roles
|
|
29
|
+
* - Multimodal content (text + images)
|
|
30
|
+
* - Tool/function calling
|
|
31
|
+
*
|
|
32
|
+
* **Streaming:** Set `stream: true` in the request body to receive Server-Sent
|
|
33
|
+
* Events (SSE) stream with incremental chunks. Perfect for ChatGPT-like real-time
|
|
34
|
+
* chat interfaces.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const response = await client.agents.chat('name', {
|
|
39
|
+
* messages: [
|
|
40
|
+
* { role: 'user', content: 'What is the weather today?' },
|
|
41
|
+
* ],
|
|
42
|
+
* });
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
chat(name, body, options) {
|
|
46
|
+
return this._client.post(path `/agents/${name}/chat`, { body, ...options });
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Execute a one-shot task with an agent. This endpoint is designed for
|
|
50
|
+
* task-oriented operations where you provide input and receive a complete output.
|
|
51
|
+
*
|
|
52
|
+
* **Timeout:** Agent invocations have a 60-second timeout. If the agent takes
|
|
53
|
+
* longer to respond, you will receive a 504 Gateway Timeout error. For
|
|
54
|
+
* long-running tasks, consider using streaming mode which does not have the same
|
|
55
|
+
* timeout constraints.
|
|
56
|
+
*
|
|
57
|
+
* **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
|
|
58
|
+
* with a unique value (e.g., UUID) to ensure duplicate requests return the same
|
|
59
|
+
* response. Keys are valid for 24 hours. Streaming responses are not cached.
|
|
60
|
+
*
|
|
61
|
+
* **Use cases:**
|
|
62
|
+
*
|
|
63
|
+
* - Data analysis and processing
|
|
64
|
+
* - Content generation (with streaming for long outputs)
|
|
65
|
+
* - One-time operations that don't require conversation history
|
|
66
|
+
* - API-like operations
|
|
67
|
+
*
|
|
68
|
+
* **Streaming:** Set `stream: true` in the request body to receive Server-Sent
|
|
69
|
+
* Events (SSE) stream with incremental chunks. Useful for long-running tasks or
|
|
70
|
+
* real-time progress updates.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* const response = await client.agents.invoke('name', {
|
|
75
|
+
* input: {
|
|
76
|
+
* task: 'analyze this data',
|
|
77
|
+
* data: { value: 123, items: ['a', 'b', 'c'] },
|
|
78
|
+
* },
|
|
79
|
+
* });
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
invoke(name, body, options) {
|
|
83
|
+
return this._client.post(path `/agents/${name}/invoke`, { body, ...options });
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
//# sourceMappingURL=agents.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"agents.mjs","sourceRoot":"","sources":["../src/resources/agents.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,IAAI,CAAC,IAAY,EAAE,IAAqB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,WAAW,IAAI,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,IAAY,EAAE,IAAuB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,WAAW,IAAI,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,EACN,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,iBAAiB,GACvB;OACM,EAAE,OAAO,EAAE,KAAK,uBAAuB,EAAE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,EACN,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,iBAAiB,GACvB;OACM,EAAE,OAAO,EAAE,KAAK,uBAAuB,EAAE"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Project = exports.Agents = void 0;
|
|
5
|
+
var agents_1 = require("./agents.js");
|
|
6
|
+
Object.defineProperty(exports, "Agents", { enumerable: true, get: function () { return agents_1.Agents; } });
|
|
7
|
+
var project_1 = require("./project.js");
|
|
8
|
+
Object.defineProperty(exports, "Project", { enumerable: true, get: function () { return project_1.Project; } });
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAOkB;AANhB,gGAAA,MAAM,OAAA;AAOR,wCAAkE;AAAzD,kGAAA,OAAO,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,MAAM,GAMP;OACM,EAAE,OAAO,EAAgC"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class Project extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Returns the project associated with the API key used for authentication.
|
|
7
|
+
*
|
|
8
|
+
* The project contains metadata about your organization's configuration,
|
|
9
|
+
* including:
|
|
10
|
+
*
|
|
11
|
+
* - Project ID and organization ID
|
|
12
|
+
* - Project name and slug
|
|
13
|
+
* - Creation and update timestamps
|
|
14
|
+
*
|
|
15
|
+
* This endpoint is useful for verifying your API key is valid and retrieving
|
|
16
|
+
* project details.
|
|
17
|
+
*/
|
|
18
|
+
retrieve(options?: RequestOptions): APIPromise<ProjectRetrieveResponse>;
|
|
19
|
+
}
|
|
20
|
+
export interface ProjectRetrieveResponse {
|
|
21
|
+
/**
|
|
22
|
+
* Unique identifier for the project
|
|
23
|
+
*/
|
|
24
|
+
id: string;
|
|
25
|
+
/**
|
|
26
|
+
* ISO 8601 timestamp when the project was created
|
|
27
|
+
*/
|
|
28
|
+
createdAt: string;
|
|
29
|
+
/**
|
|
30
|
+
* Human-readable name of the project
|
|
31
|
+
*/
|
|
32
|
+
name: string;
|
|
33
|
+
/**
|
|
34
|
+
* ID of the organization that owns this project
|
|
35
|
+
*/
|
|
36
|
+
organizationId: string;
|
|
37
|
+
/**
|
|
38
|
+
* URL-friendly identifier for the project
|
|
39
|
+
*/
|
|
40
|
+
slug: string;
|
|
41
|
+
/**
|
|
42
|
+
* ISO 8601 timestamp when the project was last updated
|
|
43
|
+
*/
|
|
44
|
+
updatedAt: string;
|
|
45
|
+
}
|
|
46
|
+
export declare namespace Project {
|
|
47
|
+
export { type ProjectRetrieveResponse as ProjectRetrieveResponse };
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=project.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"project.d.mts","sourceRoot":"","sources":["../src/resources/project.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGxE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACpE"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class Project extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Returns the project associated with the API key used for authentication.
|
|
7
|
+
*
|
|
8
|
+
* The project contains metadata about your organization's configuration,
|
|
9
|
+
* including:
|
|
10
|
+
*
|
|
11
|
+
* - Project ID and organization ID
|
|
12
|
+
* - Project name and slug
|
|
13
|
+
* - Creation and update timestamps
|
|
14
|
+
*
|
|
15
|
+
* This endpoint is useful for verifying your API key is valid and retrieving
|
|
16
|
+
* project details.
|
|
17
|
+
*/
|
|
18
|
+
retrieve(options?: RequestOptions): APIPromise<ProjectRetrieveResponse>;
|
|
19
|
+
}
|
|
20
|
+
export interface ProjectRetrieveResponse {
|
|
21
|
+
/**
|
|
22
|
+
* Unique identifier for the project
|
|
23
|
+
*/
|
|
24
|
+
id: string;
|
|
25
|
+
/**
|
|
26
|
+
* ISO 8601 timestamp when the project was created
|
|
27
|
+
*/
|
|
28
|
+
createdAt: string;
|
|
29
|
+
/**
|
|
30
|
+
* Human-readable name of the project
|
|
31
|
+
*/
|
|
32
|
+
name: string;
|
|
33
|
+
/**
|
|
34
|
+
* ID of the organization that owns this project
|
|
35
|
+
*/
|
|
36
|
+
organizationId: string;
|
|
37
|
+
/**
|
|
38
|
+
* URL-friendly identifier for the project
|
|
39
|
+
*/
|
|
40
|
+
slug: string;
|
|
41
|
+
/**
|
|
42
|
+
* ISO 8601 timestamp when the project was last updated
|
|
43
|
+
*/
|
|
44
|
+
updatedAt: string;
|
|
45
|
+
}
|
|
46
|
+
export declare namespace Project {
|
|
47
|
+
export { type ProjectRetrieveResponse as ProjectRetrieveResponse };
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=project.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../src/resources/project.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGxE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACpE"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Project = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
class Project extends resource_1.APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Returns the project associated with the API key used for authentication.
|
|
9
|
+
*
|
|
10
|
+
* The project contains metadata about your organization's configuration,
|
|
11
|
+
* including:
|
|
12
|
+
*
|
|
13
|
+
* - Project ID and organization ID
|
|
14
|
+
* - Project name and slug
|
|
15
|
+
* - Creation and update timestamps
|
|
16
|
+
*
|
|
17
|
+
* This endpoint is useful for verifying your API key is valid and retrieving
|
|
18
|
+
* project details.
|
|
19
|
+
*/
|
|
20
|
+
retrieve(options) {
|
|
21
|
+
return this._client.get('/project', options);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
exports.Project = Project;
|
|
25
|
+
//# sourceMappingURL=project.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"project.js","sourceRoot":"","sources":["../src/resources/project.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;CACF;AAjBD,0BAiBC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
export class Project extends APIResource {
|
|
4
|
+
/**
|
|
5
|
+
* Returns the project associated with the API key used for authentication.
|
|
6
|
+
*
|
|
7
|
+
* The project contains metadata about your organization's configuration,
|
|
8
|
+
* including:
|
|
9
|
+
*
|
|
10
|
+
* - Project ID and organization ID
|
|
11
|
+
* - Project name and slug
|
|
12
|
+
* - Creation and update timestamps
|
|
13
|
+
*
|
|
14
|
+
* This endpoint is useful for verifying your API key is valid and retrieving
|
|
15
|
+
* project details.
|
|
16
|
+
*/
|
|
17
|
+
retrieve(options) {
|
|
18
|
+
return this._client.get('/project', options);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=project.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"project.mjs","sourceRoot":"","sources":["../src/resources/project.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;CACF"}
|
package/resources.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.mts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.js
ADDED
package/resources.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}
|
package/resources.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|