From 9141ceb93674fd9c3d8161f11fee94618304f438 Mon Sep 17 00:00:00 2001 From: paperspaceBen Date: Tue, 18 Mar 2025 22:58:40 +0100 Subject: [PATCH 1/4] gen-ai updates march 18 --- specification/DigitalOcean-public.v2.yaml | 52 +++-- .../resources/gen-ai/definitions.yml | 215 +++++++++++++++++- .../curl/genai_create_openai_api_key.yml | 10 + .../curl/genai_delete_openai_api_key.yml | 6 + .../curl/genai_get_openai_api_key.yml | 6 + .../curl/genai_list_agents_by_openai_key.yml | 6 + .../curl/genai_list_openai_api_keys.yml | 6 + .../curl/genai_update_openai_api_key.yml | 10 + .../gen-ai/genai_create_openai_api_key.yml | 39 ++++ .../gen-ai/genai_delete_openai_api_key.yml | 42 ++++ .../gen-ai/genai_get_openai_api_key.yml | 42 ++++ .../genai_list_agents_by_openai_key.yml | 54 +++++ .../gen-ai/genai_list_guardrails.yml | 47 ++++ .../resources/gen-ai/genai_list_models.yml | 2 + .../gen-ai/genai_list_openai_api_keys.yml | 47 ++++ .../gen-ai/genai_update_openai_api_key.yml | 47 ++++ 16 files changed, 615 insertions(+), 16 deletions(-) create mode 100644 specification/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml create mode 100644 specification/resources/gen-ai/examples/curl/genai_delete_openai_api_key.yml create mode 100644 specification/resources/gen-ai/examples/curl/genai_get_openai_api_key.yml create mode 100644 specification/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.yml create mode 100644 specification/resources/gen-ai/examples/curl/genai_list_openai_api_keys.yml create mode 100644 specification/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml create mode 100644 specification/resources/gen-ai/genai_create_openai_api_key.yml create mode 100644 specification/resources/gen-ai/genai_delete_openai_api_key.yml create mode 100644 specification/resources/gen-ai/genai_get_openai_api_key.yml create mode 100644 specification/resources/gen-ai/genai_list_agents_by_openai_key.yml create mode 100644 specification/resources/gen-ai/genai_list_guardrails.yml create mode 100644 specification/resources/gen-ai/genai_list_openai_api_keys.yml create mode 100644 specification/resources/gen-ai/genai_update_openai_api_key.yml diff --git a/specification/DigitalOcean-public.v2.yaml b/specification/DigitalOcean-public.v2.yaml index daa454c36..c250e476f 100644 --- a/specification/DigitalOcean-public.v2.yaml +++ b/specification/DigitalOcean-public.v2.yaml @@ -1851,13 +1851,14 @@ paths: - /v2/gen-ai/agents: - post: - $ref: 'resources/gen-ai/genai_create_agent.yml' + /v2/gen-ai/agents: get: $ref: 'resources/gen-ai/genai_list_agents.yml' + post: + $ref: 'resources/gen-ai/genai_create_agent.yml' + /v2/gen-ai/agents/{agent_uuid}/api_keys: get: @@ -1886,12 +1887,12 @@ paths: /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}: - put: - $ref: 'resources/gen-ai/genai_update_agent_function.yml' - delete: $ref: 'resources/gen-ai/genai_detach_agent_function.yml' + put: + $ref: 'resources/gen-ai/genai_update_agent_function.yml' + /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}: delete: @@ -1902,15 +1903,15 @@ paths: /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}: + put: + $ref: 'resources/gen-ai/genai_update_attached_agent.yml' + delete: $ref: 'resources/gen-ai/genai_detach_agent.yml' post: $ref: 'resources/gen-ai/genai_attach_agent.yml' - put: - $ref: 'resources/gen-ai/genai_update_attached_agent.yml' - /v2/gen-ai/agents/{uuid}: delete: @@ -2002,27 +2003,50 @@ paths: /v2/gen-ai/knowledge_bases/{uuid}: + get: + $ref: 'resources/gen-ai/genai_get_knowledge_base.yml' + put: $ref: 'resources/gen-ai/genai_update_knowledge_base.yml' delete: $ref: 'resources/gen-ai/genai_delete_knowledge_base.yml' - get: - $ref: 'resources/gen-ai/genai_get_knowledge_base.yml' - /v2/gen-ai/models: get: $ref: 'resources/gen-ai/genai_list_models.yml' - /v2/gen-ai/regions: + /v2/gen-ai/openai/keys: get: - $ref: 'resources/gen-ai/genai_list_datacenter_regions.yml' + $ref: 'resources/gen-ai/genai_list_openai_api_keys.yml' + + post: + $ref: 'resources/gen-ai/genai_create_openai_api_key.yml' + /v2/gen-ai/openai/keys/{api_key_uuid}: + delete: + $ref: 'resources/gen-ai/genai_delete_openai_api_key.yml' + + get: + $ref: 'resources/gen-ai/genai_get_openai_api_key.yml' + + put: + $ref: 'resources/gen-ai/genai_update_openai_api_key.yml' + + + /v2/gen-ai/openai/keys/{uuid}/agents: + get: + $ref: 'resources/gen-ai/genai_list_agents_by_openai_key.yml' + + + /v2/gen-ai/regions: + get: + $ref: 'resources/gen-ai/genai_list_datacenter_regions.yml' + diff --git a/specification/resources/gen-ai/definitions.yml b/specification/resources/gen-ai/definitions.yml index 45ccf4424..94b7a471b 100644 --- a/specification/resources/gen-ai/definitions.yml +++ b/specification/resources/gen-ai/definitions.yml @@ -79,6 +79,8 @@ apiAgent: description: Agent name example: '"example name"' type: string + openai_api_key: + $ref: '#/apiOpenAIAPIKeyInfo' parent_agents: description: Parent agents items: @@ -91,6 +93,8 @@ apiAgent: description: Region code example: '"example string"' type: string + retrieval_method: + $ref: '#/apiRetrievalMethod' route_created_at: description: Creation of route date / time example: "2023-01-01T00:00:00Z" @@ -374,6 +378,8 @@ apiAgentPublic: description: Region code example: '"tor1"' type: string + retrieval_method: + $ref: '#/apiRetrievalMethod' route_created_at: description: Creation of route date / time example: "2021-01-01T00:00:00Z" @@ -714,6 +720,10 @@ apiCreateAgentInputPublic: description: Agent name example: '"My Agent"' type: string + open_ai_key_uuid: + description: Optional OpenAI API key ID to use with OpenAI models + example: '"12345678-1234-1234-1234-123456789012"' + type: string project_id: description: The id of the DigitalOcean project this agent will belong to example: '"12345678-1234-1234-1234-123456789012"' @@ -789,14 +799,14 @@ apiCreateGuardrailOutput: apiCreateKnowledgeBaseDataSourceInputPublic: description: Data to create a knowledge base data source properties: - file_upload_data_source: - $ref: '#/apiFileUploadDataSource' knowledge_base_uuid: description: Knowledge base id example: '"12345678-1234-1234-1234-123456789012"' type: string spaces_data_source: $ref: '#/apiSpacesDataSource' + web_crawler_data_source: + $ref: '#/apiWebCrawlerDataSource' type: object apiCreateKnowledgeBaseDataSourceOutput: description: Information about a newly created knowldege base data source @@ -863,6 +873,26 @@ apiCreateModelOutput: model: $ref: '#/apiModel' type: object +apiCreateOpenAIAPIKeyInputPublic: + description: CreateOpenAIAPIKeyInputPublic is used to create a new OpenAI API key + for a specific agent. + properties: + api_key: + description: OpenAI API key + example: '"sk-proj--123456789098765432123456789"' + type: string + name: + description: Name of the key + example: '"Production Key"' + type: string + type: object +apiCreateOpenAIAPIKeyOutput: + description: CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI + API key. + properties: + api_key_info: + $ref: '#/apiOpenAIAPIKeyInfo' + type: object apiDeleteAgentAPIKeyInputPublic: properties: agent_uuid: @@ -944,6 +974,16 @@ apiDeleteKnowledgeBaseOutput: example: '"123e4567-e89b-12d3-a456-426614174000"' type: string type: object +apiDeleteOpenAIAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteOpenAIAPIKeyOutput: + description: DeleteOpenAIAPIKeyOutput is used to return the deleted OpenAI API key. + properties: + api_key_info: + $ref: '#/apiOpenAIAPIKeyInfo' + type: object apiDeployment: description: Description of deployment properties: @@ -1191,6 +1231,15 @@ apiGetModelVersionsInputPublic: properties: name: example: '"My Model"' +apiGetOpenAIAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetOpenAIAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiOpenAIAPIKeyInfo' + type: object apiGetPreferredRegionOutput: description: Region code of preferred Regions properties: @@ -1381,11 +1430,31 @@ apiIndexedDataSource: description: Uuid of the indexed data source example: '"123e4567-e89b-12d3-a456-426614174000"' type: string + failed_item_count: + description: Total count of files that have failed + example: '"12345"' + format: uint64 + type: string indexed_file_count: description: Total count of files that have been indexed example: '"12345"' format: uint64 type: string + indexed_item_count: + description: Total count of files that have been indexed + example: '"12345"' + format: uint64 + type: string + removed_item_count: + description: Total count of files that have been removed + example: '"12345"' + format: uint64 + type: string + skipped_item_count: + description: Total count of files that have been skipped + example: '"12345"' + format: uint64 + type: string started_at: description: Timestamp when data source started indexing example: "2023-01-01T00:00:00Z" @@ -1782,6 +1851,26 @@ apiListAgentsByAnthropicKeyOutput: meta: $ref: '#/apiMeta' type: object +apiListAgentsByOpenAIKeyInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiListAgentsByOpenAIKeyOutput: + description: List of Agents that are linked to a specific OpenAI Key + properties: + agents: + items: + $ref: '#/apiAgent' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object apiListAgentsInputPublic: properties: only_deployed: @@ -1945,6 +2034,15 @@ apiListKnowledgeBasePricesOutput: $ref: '#/apiKnowledgeBasePrice' type: array type: object +apiListKnowledgeBasesByDatabaseOutput: + description: List of knowledge bases + properties: + knowledge_bases: + description: The knowledge bases + items: + $ref: '#/apiKnowledgeBase' + type: array + type: object apiListKnowledgeBasesInputPublic: properties: page: @@ -2035,6 +2133,26 @@ apiListModelsOutputPublic: $ref: '#/apiModelPublic' type: array type: object +apiListOpenAIAPIKeysInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" +apiListOpenAIAPIKeysOutput: + description: ListOpenAIAPIKeysOutput is used to return the list of OpenAI API keys + for a specific agent. + properties: + api_key_infos: + description: Api key infos + items: + $ref: '#/apiOpenAIAPIKeyInfo' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object apiListRegionsOutput: description: Region Codes properties: @@ -2111,6 +2229,14 @@ apiModel: description: Download url example: '"example string"' type: string + usecases: + description: Usecases of the model + example: + - MODEL_USECASE_AGENT + - MODEL_USECASE_GUARDRAIL + items: + $ref: '#/apiModelUsecase' + type: array uuid: description: Unique id example: '"123e4567-e89b-12d3-a456-426614174000"' @@ -2140,6 +2266,7 @@ apiModelProvider: enum: - MODEL_PROVIDER_DIGITALOCEAN - MODEL_PROVIDER_ANTHROPIC + - MODEL_PROVIDER_OPENAI example: MODEL_PROVIDER_DIGITALOCEAN type: string apiModelPublic: @@ -2198,12 +2325,14 @@ apiModelUsecase: - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + - MODEL_USECASE_REASONING: The model usecase for reasoning enum: - MODEL_USECASE_UNKNOWN - MODEL_USECASE_AGENT - MODEL_USECASE_FINETUNED - MODEL_USECASE_KNOWLEDGEBASE - MODEL_USECASE_GUARDRAIL + - MODEL_USECASE_REASONING example: MODEL_USECASE_UNKNOWN type: string apiModelVersion: @@ -2225,6 +2354,43 @@ apiModelVersion: format: int64 type: integer type: object +apiOpenAIAPIKeyInfo: + description: OpenAI API Key Info + properties: + created_at: + description: Key creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: Created by user id from DO + example: '"12345"' + format: uint64 + type: string + deleted_at: + description: Key deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + models: + description: Models supported by the openAI api key + items: + $ref: '#/apiModel' + type: array + name: + description: Name + example: '"example name"' + type: string + updated_at: + description: Key last updated date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Uuid + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object apiPages: description: Information about how to reach other pages properties: @@ -2316,6 +2482,22 @@ apiResourceUsage: format: date-time type: string type: object +apiRetrievalMethod: + default: RETRIEVAL_METHOD_UNKNOWN + description: |- + - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown + - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite + - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back + - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries + - RETRIEVAL_METHOD_NONE: The retrieval method is none + enum: + - RETRIEVAL_METHOD_UNKNOWN + - RETRIEVAL_METHOD_REWRITE + - RETRIEVAL_METHOD_STEP_BACK + - RETRIEVAL_METHOD_SUB_QUERIES + - RETRIEVAL_METHOD_NONE + example: RETRIEVAL_METHOD_UNKNOWN + type: string apiSpacesDataSource: description: Spaces Bucket Data Source properties: @@ -2537,10 +2719,16 @@ apiUpdateAgentInputPublic: description: Agent name example: '"My New Agent Name"' type: string + open_ai_key_uuid: + description: Optional openai key uuid for use with openai models + example: '"12345678-1234-1234-1234-123456789012"' + type: string project_id: description: The id of the DigitalOcean project this agent will belong to example: '"12345678-1234-1234-1234-123456789012"' type: string + retrieval_method: + $ref: '#/apiRetrievalMethod' tags: description: A set of abitrary tags to organize your agent example: @@ -2712,6 +2900,29 @@ apiUpdateModelMetadataOutput: model: $ref: '#/apiModel' type: object +apiUpdateOpenAIAPIKeyInputPublic: + description: UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI + API key for a specific agent. + properties: + api_key: + description: OpenAI API key + example: '"sk-ant-12345678901234567890123456789012"' + type: string + api_key_uuid: + description: API key ID + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Name of the key + example: '"Production Key"' + type: string + type: object +apiUpdateOpenAIAPIKeyOutput: + description: UpdateOpenAIAPIKeyOutput is used to return the updated OpenAI API key. + properties: + api_key_info: + $ref: '#/apiOpenAIAPIKeyInfo' + type: object apiUsageMeasurement: description: Usage Measurement Description properties: diff --git a/specification/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml b/specification/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml new file mode 100644 index 000000000..b0ca715db --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys" \ + -d '{ + "api_key": "sk-proj--12345678901234567890123456789012", + "name": "test-key" + }' diff --git a/specification/resources/gen-ai/examples/curl/genai_delete_openai_api_key.yml b/specification/resources/gen-ai/examples/curl/genai_delete_openai_api_key.yml new file mode 100644 index 000000000..716558681 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_delete_openai_api_key.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" diff --git a/specification/resources/gen-ai/examples/curl/genai_get_openai_api_key.yml b/specification/resources/gen-ai/examples/curl/genai_get_openai_api_key.yml new file mode 100644 index 000000000..3b91b6e2b --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_get_openai_api_key.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" diff --git a/specification/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.yml b/specification/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.yml new file mode 100644 index 000000000..3ab88decf --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4/agents" diff --git a/specification/resources/gen-ai/examples/curl/genai_list_openai_api_keys.yml b/specification/resources/gen-ai/examples/curl/genai_list_openai_api_keys.yml new file mode 100644 index 000000000..33db23cf3 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_list_openai_api_keys.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys" diff --git a/specification/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml b/specification/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml new file mode 100644 index 000000000..a2a7537d9 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" \ + -d '{ + "api_key_uuid": "11efb7d6-cdb5-6388-bf8f-4e013e2ddde4", + "name": "test-key2" + }' diff --git a/specification/resources/gen-ai/genai_create_openai_api_key.yml b/specification/resources/gen-ai/genai_create_openai_api_key.yml new file mode 100644 index 000000000..eea7a0346 --- /dev/null +++ b/specification/resources/gen-ai/genai_create_openai_api_key.yml @@ -0,0 +1,39 @@ +description: To create an OpenAI API key, send a POST request to `/v2/gen-ai/openai/keys`. +operationId: genai_create_openai_api_key +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateOpenAIAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateOpenAIAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create OpenAI API Key +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_create_openai_api_key.yml diff --git a/specification/resources/gen-ai/genai_delete_openai_api_key.yml b/specification/resources/gen-ai/genai_delete_openai_api_key.yml new file mode 100644 index 000000000..f73b17dc2 --- /dev/null +++ b/specification/resources/gen-ai/genai_delete_openai_api_key.yml @@ -0,0 +1,42 @@ +description: To delete an OpenAI API key, send a DELETE request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. +operationId: genai_delete_openai_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteOpenAIAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete OpenAI API Key +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_delete_openai_api_key.yml diff --git a/specification/resources/gen-ai/genai_get_openai_api_key.yml b/specification/resources/gen-ai/genai_get_openai_api_key.yml new file mode 100644 index 000000000..ff0e8f40b --- /dev/null +++ b/specification/resources/gen-ai/genai_get_openai_api_key.yml @@ -0,0 +1,42 @@ +description: To retrieve details of an OpenAI API key, send a GET request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. +operationId: genai_get_openai_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetOpenAIAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Get OpenAI API Key +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_get_openai_api_key.yml diff --git a/specification/resources/gen-ai/genai_list_agents_by_openai_key.yml b/specification/resources/gen-ai/genai_list_agents_by_openai_key.yml new file mode 100644 index 000000000..5015adf62 --- /dev/null +++ b/specification/resources/gen-ai/genai_list_agents_by_openai_key.yml @@ -0,0 +1,54 @@ +description: List Agents by OpenAI Key. +operationId: genai_list_agents_by_openai_key +parameters: +- description: Unique ID of OpenAI key + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentsByOpenAIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List agents by OpenAI key +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_agents_by_openai_key.yml diff --git a/specification/resources/gen-ai/genai_list_guardrails.yml b/specification/resources/gen-ai/genai_list_guardrails.yml new file mode 100644 index 000000000..e8ea39274 --- /dev/null +++ b/specification/resources/gen-ai/genai_list_guardrails.yml @@ -0,0 +1,47 @@ +description: To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/guardrails`. +operationId: genai_list_guardrails +parameters: +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListKnowledgeBasesOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Guardrails +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_guardrails.yml diff --git a/specification/resources/gen-ai/genai_list_models.yml b/specification/resources/gen-ai/genai_list_models.yml index 4cc7143a3..3ec45575c 100644 --- a/specification/resources/gen-ai/genai_list_models.yml +++ b/specification/resources/gen-ai/genai_list_models.yml @@ -9,6 +9,7 @@ parameters: - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + - MODEL_USECASE_REASONING: The model usecase for reasoning example: - MODEL_USECASE_UNKNOWN in: query @@ -21,6 +22,7 @@ parameters: - MODEL_USECASE_FINETUNED - MODEL_USECASE_KNOWLEDGEBASE - MODEL_USECASE_GUARDRAIL + - MODEL_USECASE_REASONING type: string type: array - description: Only include models that are publicly available. diff --git a/specification/resources/gen-ai/genai_list_openai_api_keys.yml b/specification/resources/gen-ai/genai_list_openai_api_keys.yml new file mode 100644 index 000000000..4cd619434 --- /dev/null +++ b/specification/resources/gen-ai/genai_list_openai_api_keys.yml @@ -0,0 +1,47 @@ +description: To list all OpenAI API keys, send a GET request to `/v2/gen-ai/openai/keys`. +operationId: genai_list_openai_api_keys +parameters: +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListOpenAIAPIKeysOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List OpenAI API Keys +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_openai_api_keys.yml diff --git a/specification/resources/gen-ai/genai_update_openai_api_key.yml b/specification/resources/gen-ai/genai_update_openai_api_key.yml new file mode 100644 index 000000000..ed2a1d937 --- /dev/null +++ b/specification/resources/gen-ai/genai_update_openai_api_key.yml @@ -0,0 +1,47 @@ +description: To update an OpenAI API key, send a PUT request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. +operationId: genai_update_openai_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateOpenAIAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateOpenAIAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update OpenAI API Key +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_update_openai_api_key.yml From be36f93107687f263cf2cadeaaac2ab39d98a9c6 Mon Sep 17 00:00:00 2001 From: paperspaceBen Date: Wed, 19 Mar 2025 19:48:16 +0100 Subject: [PATCH 2/4] updated with latest official api --- specification/DigitalOcean-public.v2.yaml | 49 +++++------------ .../resources/gen-ai/definitions.yml | 24 --------- .../gen-ai/genai_create_openai_api_key.yml | 39 -------------- .../gen-ai/genai_delete_openai_api_key.yml | 42 --------------- .../gen-ai/genai_get_openai_api_key.yml | 42 --------------- .../genai_list_agents_by_openai_key.yml | 54 ------------------- .../gen-ai/genai_list_guardrails.yml | 47 ---------------- .../gen-ai/genai_list_openai_api_keys.yml | 47 ---------------- .../gen-ai/genai_update_openai_api_key.yml | 47 ---------------- 9 files changed, 12 insertions(+), 379 deletions(-) delete mode 100644 specification/resources/gen-ai/genai_create_openai_api_key.yml delete mode 100644 specification/resources/gen-ai/genai_delete_openai_api_key.yml delete mode 100644 specification/resources/gen-ai/genai_get_openai_api_key.yml delete mode 100644 specification/resources/gen-ai/genai_list_agents_by_openai_key.yml delete mode 100644 specification/resources/gen-ai/genai_list_guardrails.yml delete mode 100644 specification/resources/gen-ai/genai_list_openai_api_keys.yml delete mode 100644 specification/resources/gen-ai/genai_update_openai_api_key.yml diff --git a/specification/DigitalOcean-public.v2.yaml b/specification/DigitalOcean-public.v2.yaml index c250e476f..9a2c7e9c6 100644 --- a/specification/DigitalOcean-public.v2.yaml +++ b/specification/DigitalOcean-public.v2.yaml @@ -1853,12 +1853,12 @@ paths: /v2/gen-ai/agents: - get: - $ref: 'resources/gen-ai/genai_list_agents.yml' - post: $ref: 'resources/gen-ai/genai_create_agent.yml' + get: + $ref: 'resources/gen-ai/genai_list_agents.yml' + /v2/gen-ai/agents/{agent_uuid}/api_keys: get: @@ -1903,15 +1903,15 @@ paths: /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}: - put: - $ref: 'resources/gen-ai/genai_update_attached_agent.yml' - delete: $ref: 'resources/gen-ai/genai_detach_agent.yml' post: $ref: 'resources/gen-ai/genai_attach_agent.yml' + put: + $ref: 'resources/gen-ai/genai_update_attached_agent.yml' + /v2/gen-ai/agents/{uuid}: delete: @@ -1943,15 +1943,15 @@ paths: /v2/gen-ai/anthropic/keys/{api_key_uuid}: + put: + $ref: 'resources/gen-ai/genai_update_anthropic_api_key.yml' + delete: $ref: 'resources/gen-ai/genai_delete_anthropic_api_key.yml' get: $ref: 'resources/gen-ai/genai_get_anthropic_api_key.yml' - put: - $ref: 'resources/gen-ai/genai_update_anthropic_api_key.yml' - /v2/gen-ai/anthropic/keys/{uuid}/agents: get: @@ -2003,50 +2003,25 @@ paths: /v2/gen-ai/knowledge_bases/{uuid}: + delete: + $ref: 'resources/gen-ai/genai_delete_knowledge_base.yml' + get: $ref: 'resources/gen-ai/genai_get_knowledge_base.yml' put: $ref: 'resources/gen-ai/genai_update_knowledge_base.yml' - delete: - $ref: 'resources/gen-ai/genai_delete_knowledge_base.yml' - /v2/gen-ai/models: get: $ref: 'resources/gen-ai/genai_list_models.yml' - /v2/gen-ai/openai/keys: - get: - $ref: 'resources/gen-ai/genai_list_openai_api_keys.yml' - - post: - $ref: 'resources/gen-ai/genai_create_openai_api_key.yml' - - - /v2/gen-ai/openai/keys/{api_key_uuid}: - delete: - $ref: 'resources/gen-ai/genai_delete_openai_api_key.yml' - - get: - $ref: 'resources/gen-ai/genai_get_openai_api_key.yml' - - put: - $ref: 'resources/gen-ai/genai_update_openai_api_key.yml' - - - /v2/gen-ai/openai/keys/{uuid}/agents: - get: - $ref: 'resources/gen-ai/genai_list_agents_by_openai_key.yml' - - /v2/gen-ai/regions: get: $ref: 'resources/gen-ai/genai_list_datacenter_regions.yml' - diff --git a/specification/resources/gen-ai/definitions.yml b/specification/resources/gen-ai/definitions.yml index 94b7a471b..6ee34ec2f 100644 --- a/specification/resources/gen-ai/definitions.yml +++ b/specification/resources/gen-ai/definitions.yml @@ -720,10 +720,6 @@ apiCreateAgentInputPublic: description: Agent name example: '"My Agent"' type: string - open_ai_key_uuid: - description: Optional OpenAI API key ID to use with OpenAI models - example: '"12345678-1234-1234-1234-123456789012"' - type: string project_id: description: The id of the DigitalOcean project this agent will belong to example: '"12345678-1234-1234-1234-123456789012"' @@ -874,18 +870,11 @@ apiCreateModelOutput: $ref: '#/apiModel' type: object apiCreateOpenAIAPIKeyInputPublic: - description: CreateOpenAIAPIKeyInputPublic is used to create a new OpenAI API key - for a specific agent. properties: api_key: - description: OpenAI API key example: '"sk-proj--123456789098765432123456789"' - type: string name: - description: Name of the key example: '"Production Key"' - type: string - type: object apiCreateOpenAIAPIKeyOutput: description: CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI API key. @@ -2719,10 +2708,6 @@ apiUpdateAgentInputPublic: description: Agent name example: '"My New Agent Name"' type: string - open_ai_key_uuid: - description: Optional openai key uuid for use with openai models - example: '"12345678-1234-1234-1234-123456789012"' - type: string project_id: description: The id of the DigitalOcean project this agent will belong to example: '"12345678-1234-1234-1234-123456789012"' @@ -2901,22 +2886,13 @@ apiUpdateModelMetadataOutput: $ref: '#/apiModel' type: object apiUpdateOpenAIAPIKeyInputPublic: - description: UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI - API key for a specific agent. properties: api_key: - description: OpenAI API key example: '"sk-ant-12345678901234567890123456789012"' - type: string api_key_uuid: - description: API key ID example: '"12345678-1234-1234-1234-123456789012"' - type: string name: - description: Name of the key example: '"Production Key"' - type: string - type: object apiUpdateOpenAIAPIKeyOutput: description: UpdateOpenAIAPIKeyOutput is used to return the updated OpenAI API key. properties: diff --git a/specification/resources/gen-ai/genai_create_openai_api_key.yml b/specification/resources/gen-ai/genai_create_openai_api_key.yml deleted file mode 100644 index eea7a0346..000000000 --- a/specification/resources/gen-ai/genai_create_openai_api_key.yml +++ /dev/null @@ -1,39 +0,0 @@ -description: To create an OpenAI API key, send a POST request to `/v2/gen-ai/openai/keys`. -operationId: genai_create_openai_api_key -requestBody: - content: - application/json: - schema: - $ref: ./definitions.yml#/apiCreateOpenAIAPIKeyInputPublic -responses: - "200": - content: - application/json: - schema: - $ref: ./definitions.yml#/apiCreateOpenAIAPIKeyOutput - description: A successful response. - headers: - ratelimit-limit: - $ref: ../../shared/headers.yml#/ratelimit-limit - ratelimit-remaining: - $ref: ../../shared/headers.yml#/ratelimit-remaining - ratelimit-reset: - $ref: ../../shared/headers.yml#/ratelimit-reset - "401": - $ref: ../../shared/responses/unauthorized.yml - "404": - $ref: ../../shared/responses/not_found.yml - "429": - $ref: ../../shared/responses/too_many_requests.yml - "500": - $ref: ../../shared/responses/server_error.yml - default: - $ref: ../../shared/responses/unexpected_error.yml -security: -- bearer_auth: - - genai:create -summary: Create OpenAI API Key -tags: -- GenAI Platform (Public Preview) -x-codeSamples: -- $ref: examples/curl/genai_create_openai_api_key.yml diff --git a/specification/resources/gen-ai/genai_delete_openai_api_key.yml b/specification/resources/gen-ai/genai_delete_openai_api_key.yml deleted file mode 100644 index f73b17dc2..000000000 --- a/specification/resources/gen-ai/genai_delete_openai_api_key.yml +++ /dev/null @@ -1,42 +0,0 @@ -description: To delete an OpenAI API key, send a DELETE request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. -operationId: genai_delete_openai_api_key -parameters: -- description: API key ID - example: '"123e4567-e89b-12d3-a456-426614174000"' - in: path - name: api_key_uuid - required: true - schema: - type: string -responses: - "200": - content: - application/json: - schema: - $ref: ./definitions.yml#/apiDeleteOpenAIAPIKeyOutput - description: A successful response. - headers: - ratelimit-limit: - $ref: ../../shared/headers.yml#/ratelimit-limit - ratelimit-remaining: - $ref: ../../shared/headers.yml#/ratelimit-remaining - ratelimit-reset: - $ref: ../../shared/headers.yml#/ratelimit-reset - "401": - $ref: ../../shared/responses/unauthorized.yml - "404": - $ref: ../../shared/responses/not_found.yml - "429": - $ref: ../../shared/responses/too_many_requests.yml - "500": - $ref: ../../shared/responses/server_error.yml - default: - $ref: ../../shared/responses/unexpected_error.yml -security: -- bearer_auth: - - genai:delete -summary: Delete OpenAI API Key -tags: -- GenAI Platform (Public Preview) -x-codeSamples: -- $ref: examples/curl/genai_delete_openai_api_key.yml diff --git a/specification/resources/gen-ai/genai_get_openai_api_key.yml b/specification/resources/gen-ai/genai_get_openai_api_key.yml deleted file mode 100644 index ff0e8f40b..000000000 --- a/specification/resources/gen-ai/genai_get_openai_api_key.yml +++ /dev/null @@ -1,42 +0,0 @@ -description: To retrieve details of an OpenAI API key, send a GET request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. -operationId: genai_get_openai_api_key -parameters: -- description: API key ID - example: '"123e4567-e89b-12d3-a456-426614174000"' - in: path - name: api_key_uuid - required: true - schema: - type: string -responses: - "200": - content: - application/json: - schema: - $ref: ./definitions.yml#/apiGetOpenAIAPIKeyOutput - description: A successful response. - headers: - ratelimit-limit: - $ref: ../../shared/headers.yml#/ratelimit-limit - ratelimit-remaining: - $ref: ../../shared/headers.yml#/ratelimit-remaining - ratelimit-reset: - $ref: ../../shared/headers.yml#/ratelimit-reset - "401": - $ref: ../../shared/responses/unauthorized.yml - "404": - $ref: ../../shared/responses/not_found.yml - "429": - $ref: ../../shared/responses/too_many_requests.yml - "500": - $ref: ../../shared/responses/server_error.yml - default: - $ref: ../../shared/responses/unexpected_error.yml -security: -- bearer_auth: - - genai:read -summary: Get OpenAI API Key -tags: -- GenAI Platform (Public Preview) -x-codeSamples: -- $ref: examples/curl/genai_get_openai_api_key.yml diff --git a/specification/resources/gen-ai/genai_list_agents_by_openai_key.yml b/specification/resources/gen-ai/genai_list_agents_by_openai_key.yml deleted file mode 100644 index 5015adf62..000000000 --- a/specification/resources/gen-ai/genai_list_agents_by_openai_key.yml +++ /dev/null @@ -1,54 +0,0 @@ -description: List Agents by OpenAI Key. -operationId: genai_list_agents_by_openai_key -parameters: -- description: Unique ID of OpenAI key - example: '"123e4567-e89b-12d3-a456-426614174000"' - in: path - name: uuid - required: true - schema: - type: string -- description: Page number. - example: 1 - in: query - name: page - schema: - type: integer -- description: Items per page. - example: 1 - in: query - name: per_page - schema: - type: integer -responses: - "200": - content: - application/json: - schema: - $ref: ./definitions.yml#/apiListAgentsByOpenAIKeyOutput - description: A successful response. - headers: - ratelimit-limit: - $ref: ../../shared/headers.yml#/ratelimit-limit - ratelimit-remaining: - $ref: ../../shared/headers.yml#/ratelimit-remaining - ratelimit-reset: - $ref: ../../shared/headers.yml#/ratelimit-reset - "401": - $ref: ../../shared/responses/unauthorized.yml - "404": - $ref: ../../shared/responses/not_found.yml - "429": - $ref: ../../shared/responses/too_many_requests.yml - "500": - $ref: ../../shared/responses/server_error.yml - default: - $ref: ../../shared/responses/unexpected_error.yml -security: -- bearer_auth: - - genai:read -summary: List agents by OpenAI key -tags: -- GenAI Platform (Public Preview) -x-codeSamples: -- $ref: examples/curl/genai_list_agents_by_openai_key.yml diff --git a/specification/resources/gen-ai/genai_list_guardrails.yml b/specification/resources/gen-ai/genai_list_guardrails.yml deleted file mode 100644 index e8ea39274..000000000 --- a/specification/resources/gen-ai/genai_list_guardrails.yml +++ /dev/null @@ -1,47 +0,0 @@ -description: To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/guardrails`. -operationId: genai_list_guardrails -parameters: -- description: Page number. - example: 1 - in: query - name: page - schema: - type: integer -- description: Items per page. - example: 1 - in: query - name: per_page - schema: - type: integer -responses: - "200": - content: - application/json: - schema: - $ref: ./definitions.yml#/apiListKnowledgeBasesOutput - description: A successful response. - headers: - ratelimit-limit: - $ref: ../../shared/headers.yml#/ratelimit-limit - ratelimit-remaining: - $ref: ../../shared/headers.yml#/ratelimit-remaining - ratelimit-reset: - $ref: ../../shared/headers.yml#/ratelimit-reset - "401": - $ref: ../../shared/responses/unauthorized.yml - "404": - $ref: ../../shared/responses/not_found.yml - "429": - $ref: ../../shared/responses/too_many_requests.yml - "500": - $ref: ../../shared/responses/server_error.yml - default: - $ref: ../../shared/responses/unexpected_error.yml -security: -- bearer_auth: - - genai:read -summary: List Guardrails -tags: -- GenAI Platform (Public Preview) -x-codeSamples: -- $ref: examples/curl/genai_list_guardrails.yml diff --git a/specification/resources/gen-ai/genai_list_openai_api_keys.yml b/specification/resources/gen-ai/genai_list_openai_api_keys.yml deleted file mode 100644 index 4cd619434..000000000 --- a/specification/resources/gen-ai/genai_list_openai_api_keys.yml +++ /dev/null @@ -1,47 +0,0 @@ -description: To list all OpenAI API keys, send a GET request to `/v2/gen-ai/openai/keys`. -operationId: genai_list_openai_api_keys -parameters: -- description: Page number. - example: 1 - in: query - name: page - schema: - type: integer -- description: Items per page. - example: 1 - in: query - name: per_page - schema: - type: integer -responses: - "200": - content: - application/json: - schema: - $ref: ./definitions.yml#/apiListOpenAIAPIKeysOutput - description: A successful response. - headers: - ratelimit-limit: - $ref: ../../shared/headers.yml#/ratelimit-limit - ratelimit-remaining: - $ref: ../../shared/headers.yml#/ratelimit-remaining - ratelimit-reset: - $ref: ../../shared/headers.yml#/ratelimit-reset - "401": - $ref: ../../shared/responses/unauthorized.yml - "404": - $ref: ../../shared/responses/not_found.yml - "429": - $ref: ../../shared/responses/too_many_requests.yml - "500": - $ref: ../../shared/responses/server_error.yml - default: - $ref: ../../shared/responses/unexpected_error.yml -security: -- bearer_auth: - - genai:read -summary: List OpenAI API Keys -tags: -- GenAI Platform (Public Preview) -x-codeSamples: -- $ref: examples/curl/genai_list_openai_api_keys.yml diff --git a/specification/resources/gen-ai/genai_update_openai_api_key.yml b/specification/resources/gen-ai/genai_update_openai_api_key.yml deleted file mode 100644 index ed2a1d937..000000000 --- a/specification/resources/gen-ai/genai_update_openai_api_key.yml +++ /dev/null @@ -1,47 +0,0 @@ -description: To update an OpenAI API key, send a PUT request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. -operationId: genai_update_openai_api_key -parameters: -- description: API key ID - example: '"123e4567-e89b-12d3-a456-426614174000"' - in: path - name: api_key_uuid - required: true - schema: - type: string -requestBody: - content: - application/json: - schema: - $ref: ./definitions.yml#/apiUpdateOpenAIAPIKeyInputPublic -responses: - "200": - content: - application/json: - schema: - $ref: ./definitions.yml#/apiUpdateOpenAIAPIKeyOutput - description: A successful response. - headers: - ratelimit-limit: - $ref: ../../shared/headers.yml#/ratelimit-limit - ratelimit-remaining: - $ref: ../../shared/headers.yml#/ratelimit-remaining - ratelimit-reset: - $ref: ../../shared/headers.yml#/ratelimit-reset - "401": - $ref: ../../shared/responses/unauthorized.yml - "404": - $ref: ../../shared/responses/not_found.yml - "429": - $ref: ../../shared/responses/too_many_requests.yml - "500": - $ref: ../../shared/responses/server_error.yml - default: - $ref: ../../shared/responses/unexpected_error.yml -security: -- bearer_auth: - - genai:update -summary: Update OpenAI API Key -tags: -- GenAI Platform (Public Preview) -x-codeSamples: -- $ref: examples/curl/genai_update_openai_api_key.yml From fc1f66be1bb61a333b998286cd305acc54eb155c Mon Sep 17 00:00:00 2001 From: paperspaceBen Date: Wed, 19 Mar 2025 19:53:53 +0100 Subject: [PATCH 3/4] wording change --- .../gen-ai/genai_update_agent_deployment_visibility.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml b/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml index 10d82cf41..60a752bbc 100644 --- a/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml +++ b/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml @@ -41,7 +41,7 @@ responses: security: - bearer_auth: - genai:update -summary: Check Agent Status +summary: Update Agent Status tags: - GenAI Platform (Public Preview) x-codeSamples: From 3d5f598556c04fbd802317b3073c13b6d18599a5 Mon Sep 17 00:00:00 2001 From: paperspaceBen Date: Wed, 19 Mar 2025 20:21:35 +0100 Subject: [PATCH 4/4] wording change --- .../gen-ai/genai_update_agent_deployment_visibility.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml b/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml index 60a752bbc..8aa438ace 100644 --- a/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml +++ b/specification/resources/gen-ai/genai_update_agent_deployment_visibility.yml @@ -1,4 +1,4 @@ -description: Check whether an agent is public or private. To get the agent status, +description: Check whether an agent is public or private. To update the agent status, send a PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`. operationId: genai_update_agent_deployment_visibility parameters: