{"openapi":"3.1.0","info":{"title":"Uploadcare (BYOK) API","version":"0.1.0","description":"Uploadcare (BYOK) lets an AI assistant read your own Uploadcare data through the Uploadcare API with a key you supply (public and secret key joined as PUBLIC_KEY:SECRET_KEY (paste them as one value with a colon)). Read-only: 7 tools (get_project, list_files, get_file, get_file_metadata, get_file_tags, list_groups, get_group). The BYOK key travels with each request, is used for that one call only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-uploadcare.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-uploadcare/docs"},"termsOfService":"https://connectorbay.com/byok-uploadcare/terms"},"servers":[{"url":"https://byok-uploadcare.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-uploadcare/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_project":{"post":{"operationId":"get_project","summary":"Show the Uploadcare project the keys belong to: name, public key and whether files are stored automatically. Use for \"Wh","description":"Show the Uploadcare project the keys belong to: name, public key and whether files are stored automatically. Use for \"Which Uploadcare project is my key connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_projectArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_files":{"post":{"operationId":"list_files","summary":"List files uploaded to the Uploadcare project with name, type, size, upload and store dates and image size. Up to 1000 p","description":"List files uploaded to the Uploadcare project with name, type, size, upload and store dates and image size. Up to 1000 per call; the answer has next and total. Use for \"What files were uploaded to my Uploadcare project recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"stored":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for stored files only, false for temporary (unstored) files only; leave out for both.","title":"Stored"},"removed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only removed files.","title":"Removed"},"ordering":{"anyOf":[{"enum":["datetime_uploaded","-datetime_uploaded"],"type":"string"},{"type":"null"}],"default":"-datetime_uploaded","description":"Order by datetime_uploaded (oldest first) or -datetime_uploaded (newest first).","title":"Ordering"},"from_date":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 date and time (YYYY-MM-DDTHH:MM:SSZ) to start the list from.","title":"From Date"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many files to return (1 to 1000).","title":"Limit"}},"title":"list_filesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_file":{"post":{"operationId":"get_file","summary":"Get one Uploadcare file by UUID: name, MIME type, size, dates, tags, image dimensions or video duration and public CDN U","description":"Get one Uploadcare file by UUID: name, MIME type, size, dates, tags, image dimensions or video duration and public CDN URL. Use for \"Show details of Uploadcare file 2d33999d-c74a-4ff9-99ea-abc23496b052\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"uuid":{"description":"File UUID, as returned by list_files.","maxLength":60,"title":"Uuid","type":"string"}},"required":["uuid"],"title":"get_fileArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_file_metadata":{"post":{"operationId":"get_file_metadata","summary":"Get the custom key-value metadata attached to an Uploadcare file. Use for \"What metadata is attached to this Uploadcare ","description":"Get the custom key-value metadata attached to an Uploadcare file. Use for \"What metadata is attached to this Uploadcare file\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"uuid":{"description":"File UUID, as returned by list_files.","maxLength":60,"title":"Uuid","type":"string"}},"required":["uuid"],"title":"get_file_metadataArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_file_tags":{"post":{"operationId":"get_file_tags","summary":"Get the tags of an Uploadcare file. Use for \"Which tags does this Uploadcare file have\".","description":"Get the tags of an Uploadcare file. Use for \"Which tags does this Uploadcare file have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"uuid":{"description":"File UUID, as returned by list_files.","maxLength":60,"title":"Uuid","type":"string"}},"required":["uuid"],"title":"get_file_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_groups":{"post":{"operationId":"list_groups","summary":"List Uploadcare file groups with id, creation date, file count and CDN URL. Up to 1000 per call. Use for \"What file grou","description":"List Uploadcare file groups with id, creation date, file count and CDN URL. Up to 1000 per call. Use for \"What file groups exist in my Uploadcare project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ordering":{"anyOf":[{"enum":["datetime_created","-datetime_created"],"type":"string"},{"type":"null"}],"default":"-datetime_created","description":"Order by datetime_created (oldest first) or -datetime_created (newest first).","title":"Ordering"},"from_date":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 date and time (YYYY-MM-DDTHH:MM:SSZ) to start the list from.","title":"From Date"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many groups to return (1 to 1000).","title":"Limit"}},"title":"list_groupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_group":{"post":{"operationId":"get_group","summary":"Get one Uploadcare file group by id: creation date, number of files and CDN URL. Use for \"Show Uploadcare group details\"","description":"Get one Uploadcare file group by id: creation date, number of files and CDN URL. Use for \"Show Uploadcare group details\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"uuid":{"description":"Group id, as returned by list_groups (looks like '<uuid>~<file count>').","maxLength":80,"title":"Uuid","type":"string"}},"required":["uuid"],"title":"get_groupArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}