Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 03:37 UTC
Large file — syntax highlighting disabled.
| 1 | { |
| 2 | "openapi": "3.0.0", |
| 3 | "info": { |
| 4 | "version": "3.1.0", |
| 5 | "title": "Composio Platform API v3.1", |
| 6 | "description": "Composio v3.1 API — all endpoints available under /api/v3.1/. Tool endpoints default to the latest tool version.", |
| 7 | "contact": { |
| 8 | "name": "Composio Support", |
| 9 | "url": "https://composio.dev/support", |
| 10 | "email": "support@composio.dev" |
| 11 | }, |
| 12 | "license": { |
| 13 | "name": "Proprietary", |
| 14 | "url": "https://composio.dev/terms" |
| 15 | } |
| 16 | }, |
| 17 | "servers": [ |
| 18 | { |
| 19 | "url": "https://backend.composio.dev", |
| 20 | "description": "PRODUCTION API" |
| 21 | } |
| 22 | ], |
| 23 | "tags": [ |
| 24 | { |
| 25 | "name": "Authentication", |
| 26 | "description": "Authentication related endpoints" |
| 27 | }, |
| 28 | { |
| 29 | "name": "Auth Configs", |
| 30 | "description": "Authentication configuration management" |
| 31 | }, |
| 32 | { |
| 33 | "name": "Connected Accounts", |
| 34 | "description": "Connected account management" |
| 35 | }, |
| 36 | { |
| 37 | "name": "Logs", |
| 38 | "description": "Logging and monitoring" |
| 39 | }, |
| 40 | { |
| 41 | "name": "OpenAPI", |
| 42 | "description": "OpenAPI specification management" |
| 43 | }, |
| 44 | { |
| 45 | "name": "Organization", |
| 46 | "description": "Organization management" |
| 47 | }, |
| 48 | { |
| 49 | "name": "API Keys", |
| 50 | "description": "API key management" |
| 51 | }, |
| 52 | { |
| 53 | "name": "Webhooks", |
| 54 | "description": "Webhook configuration" |
| 55 | }, |
| 56 | { |
| 57 | "name": "Webhook Endpoints", |
| 58 | "description": "Per-OAuth-app webhook ingress endpoints. Inbound URLs the provider posts to, plus signing secret storage and verification." |
| 59 | }, |
| 60 | { |
| 61 | "name": "Webhook Subscriptions", |
| 62 | "description": "Webhook delivery subscriptions. Outbound URLs Composio posts trigger events to, plus signing secret rotation and event-type filters." |
| 63 | }, |
| 64 | { |
| 65 | "name": "Team", |
| 66 | "description": "Team member management" |
| 67 | }, |
| 68 | { |
| 69 | "name": "Consumer Skills", |
| 70 | "description": "Organization-authored Skill management" |
| 71 | }, |
| 72 | { |
| 73 | "name": "Toolkits", |
| 74 | "description": "Toolkit and tool management" |
| 75 | }, |
| 76 | { |
| 77 | "name": "Tools", |
| 78 | "description": "Tool execution endpoints" |
| 79 | }, |
| 80 | { |
| 81 | "name": "Triggers", |
| 82 | "description": "Trigger management and execution" |
| 83 | }, |
| 84 | { |
| 85 | "name": "Payments", |
| 86 | "description": "Payment and subscription management" |
| 87 | }, |
| 88 | { |
| 89 | "name": "Billing", |
| 90 | "description": "Dashboard billing state — usage, subscription, contract (cookie-auth only)" |
| 91 | }, |
| 92 | { |
| 93 | "name": "Compliance", |
| 94 | "description": "Organization compliance agreements and acceptance state" |
| 95 | }, |
| 96 | { |
| 97 | "name": "Files", |
| 98 | "description": "File management" |
| 99 | }, |
| 100 | { |
| 101 | "name": "MCP", |
| 102 | "description": "MCP server management" |
| 103 | }, |
| 104 | { |
| 105 | "name": "MCP Partner", |
| 106 | "description": "MCP partner management" |
| 107 | }, |
| 108 | { |
| 109 | "name": "Stripe Projects", |
| 110 | "description": "Stripe Projects provisioning" |
| 111 | }, |
| 112 | { |
| 113 | "name": "Tool Router", |
| 114 | "description": "(Labs) Tool router endpoints" |
| 115 | }, |
| 116 | { |
| 117 | "name": "Playground", |
| 118 | "description": "Dashboard playground chat" |
| 119 | }, |
| 120 | { |
| 121 | "name": "Arena", |
| 122 | "description": "Arena conversations, messages and terms" |
| 123 | }, |
| 124 | { |
| 125 | "name": "Projects" |
| 126 | }, |
| 127 | { |
| 128 | "name": "Organization Management" |
| 129 | } |
| 130 | ], |
| 131 | "components": { |
| 132 | "securitySchemes": { |
| 133 | "ApiKeyAuth": { |
| 134 | "type": "apiKey", |
| 135 | "in": "header", |
| 136 | "name": "x-api-key", |
| 137 | "description": "Project API key authentication" |
| 138 | }, |
| 139 | "UserApiKeyAuth": { |
| 140 | "type": "apiKey", |
| 141 | "in": "header", |
| 142 | "name": "x-user-api-key", |
| 143 | "description": "User API key authentication" |
| 144 | }, |
| 145 | "OrgApiKeyAuth": { |
| 146 | "type": "apiKey", |
| 147 | "in": "header", |
| 148 | "name": "x-org-api-key", |
| 149 | "description": "Organization API key authentication" |
| 150 | } |
| 151 | }, |
| 152 | "schemas": { |
| 153 | "Error": { |
| 154 | "type": "object", |
| 155 | "properties": { |
| 156 | "error": { |
| 157 | "type": "object", |
| 158 | "properties": { |
| 159 | "message": { |
| 160 | "type": "string" |
| 161 | }, |
| 162 | "code": { |
| 163 | "type": "number" |
| 164 | }, |
| 165 | "slug": { |
| 166 | "type": "string" |
| 167 | }, |
| 168 | "status": { |
| 169 | "type": "number" |
| 170 | }, |
| 171 | "request_id": { |
| 172 | "type": "string" |
| 173 | }, |
| 174 | "suggested_fix": { |
| 175 | "type": "string" |
| 176 | }, |
| 177 | "errors": { |
| 178 | "type": "array", |
| 179 | "items": { |
| 180 | "type": "string" |
| 181 | } |
| 182 | } |
| 183 | }, |
| 184 | "required": [ |
| 185 | "message", |
| 186 | "code", |
| 187 | "slug", |
| 188 | "status" |
| 189 | ] |
| 190 | } |
| 191 | }, |
| 192 | "required": [ |
| 193 | "error" |
| 194 | ] |
| 195 | }, |
| 196 | "ToolPricing": { |
| 197 | "type": "object", |
| 198 | "properties": { |
| 199 | "description": { |
| 200 | "type": "string", |
| 201 | "description": "Human-readable pricing description." |
| 202 | }, |
| 203 | "discount": { |
| 204 | "type": "string", |
| 205 | "nullable": true, |
| 206 | "description": "Discount on top of provider charges." |
| 207 | } |
| 208 | }, |
| 209 | "description": "Published pricing for the tool", |
| 210 | "additionalProperties": false |
| 211 | }, |
| 212 | "InstantAccount": { |
| 213 | "type": "object", |
| 214 | "properties": { |
| 215 | "supported": { |
| 216 | "type": "boolean", |
| 217 | "enum": [ |
| 218 | true |
| 219 | ] |
| 220 | }, |
| 221 | "price": { |
| 222 | "$ref": "#/components/schemas/ToolPricing" |
| 223 | } |
| 224 | }, |
| 225 | "required": [ |
| 226 | "supported" |
| 227 | ], |
| 228 | "description": "Present only when the tool supports an Instant account and its selected toolkit version is the latest. Missing for older toolkit versions or ineligible tools." |
| 229 | }, |
| 230 | "Tool": { |
| 231 | "type": "object", |
| 232 | "properties": { |
| 233 | "slug": { |
| 234 | "type": "string", |
| 235 | "description": "Unique identifier for the tool", |
| 236 | "example": "GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENT" |
| 237 | }, |
| 238 | "name": { |
| 239 | "type": "string", |
| 240 | "description": "Human-readable display name of the tool", |
| 241 | "example": "GitHub Actions" |
| 242 | }, |
| 243 | "description": { |
| 244 | "type": "string", |
| 245 | "description": "Detailed explanation of the tool's functionality and purpose", |
| 246 | "example": "Automate GitHub workflows including CI/CD, issue management, and release processes" |
| 247 | }, |
| 248 | "toolkit": { |
| 249 | "type": "object", |
| 250 | "properties": { |
| 251 | "slug": { |
| 252 | "type": "string", |
| 253 | "description": "Unique identifier of the parent toolkit", |
| 254 | "example": "github" |
| 255 | }, |
| 256 | "name": { |
| 257 | "type": "string", |
| 258 | "description": "Human-readable name of the parent toolkit", |
| 259 | "example": "GitHub" |
| 260 | }, |
| 261 | "logo": { |
| 262 | "type": "string", |
| 263 | "description": "URL to the toolkit logo image", |
| 264 | "example": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png" |
| 265 | } |
| 266 | }, |
| 267 | "required": [ |
| 268 | "slug", |
| 269 | "name", |
| 270 | "logo" |
| 271 | ] |
| 272 | }, |
| 273 | "input_parameters": { |
| 274 | "type": "object", |
| 275 | "additionalProperties": {}, |
| 276 | "description": "Schema definition of required input parameters for the tool", |
| 277 | "example": { |
| 278 | "repo_name": { |
| 279 | "type": "string", |
| 280 | "description": "GitHub repository name in owner/repo format", |
| 281 | "required": true, |
| 282 | "example": "octocat/Hello-World" |
| 283 | }, |
| 284 | "workflow_id": { |
| 285 | "type": "string", |
| 286 | "description": "ID or filename of the workflow to trigger", |
| 287 | "required": true, |
| 288 | "example": "main.yml" |
| 289 | } |
| 290 | } |
| 291 | }, |
| 292 | "no_auth": { |
| 293 | "type": "boolean", |
| 294 | "description": "Indicates if the tool can be used without authentication", |
| 295 | "example": false |
| 296 | }, |
| 297 | "available_versions": { |
| 298 | "type": "array", |
| 299 | "items": { |
| 300 | "type": "string" |
| 301 | }, |
| 302 | "description": "List of all available versions for this tool", |
| 303 | "example": [ |
| 304 | "20250905_00", |
| 305 | "20250906_00" |
| 306 | ] |
| 307 | }, |
| 308 | "version": { |
| 309 | "type": "string", |
| 310 | "description": "Current version of the tool", |
| 311 | "example": "20250905_00" |
| 312 | }, |
| 313 | "instant": { |
| 314 | "$ref": "#/components/schemas/InstantAccount" |
| 315 | }, |
| 316 | "output_parameters": { |
| 317 | "type": "object", |
| 318 | "additionalProperties": {}, |
| 319 | "description": "Schema definition of return values from the tool", |
| 320 | "example": { |
| 321 | "run_id": { |
| 322 | "type": "number", |
| 323 | "description": "ID of the workflow run that was triggered", |
| 324 | "example": 12345678 |
| 325 | }, |
| 326 | "status": { |
| 327 | "type": "string", |
| 328 | "description": "Status of the workflow run", |
| 329 | "example": "completed", |
| 330 | "enum": [ |
| 331 | "queued", |
| 332 | "in_progress", |
| 333 | "completed", |
| 334 | "failed" |
| 335 | ] |
| 336 | } |
| 337 | } |
| 338 | }, |
| 339 | "scopes": { |
| 340 | "type": "array", |
| 341 | "items": { |
| 342 | "type": "string" |
| 343 | }, |
| 344 | "description": "List of scopes associated with the tool", |
| 345 | "example": [ |
| 346 | "https://www.googleapis.com/auth/gmail.modify" |
| 347 | ] |
| 348 | }, |
| 349 | "scope_requirements": { |
| 350 | "type": "object", |
| 351 | "nullable": true, |
| 352 | "properties": { |
| 353 | "all_of": { |
| 354 | "type": "array", |
| 355 | "items": { |
| 356 | "anyOf": [ |
| 357 | { |
| 358 | "type": "string" |
| 359 | }, |
| 360 | { |
| 361 | "type": "object", |
| 362 | "properties": { |
| 363 | "any_of": { |
| 364 | "type": "array", |
| 365 | "items": { |
| 366 | "anyOf": [ |
| 367 | { |
| 368 | "type": "string" |
| 369 | }, |
| 370 | { |
| 371 | "type": "object", |
| 372 | "properties": { |
| 373 | "all_of": { |
| 374 | "type": "array", |
| 375 | "items": { |
| 376 | "type": "string" |
| 377 | }, |
| 378 | "minItems": 1 |
| 379 | }, |
| 380 | "source": { |
| 381 | "type": "array", |
| 382 | "items": { |
| 383 | "type": "string", |
| 384 | "minLength": 1 |
| 385 | }, |
| 386 | "minItems": 1 |
| 387 | } |
| 388 | }, |
| 389 | "required": [ |
| 390 | "all_of" |
| 391 | ] |
| 392 | } |
| 393 | ] |
| 394 | }, |
| 395 | "minItems": 1 |
| 396 | }, |
| 397 | "when": { |
| 398 | "type": "object", |
| 399 | "additionalProperties": { |
| 400 | "type": "array", |
| 401 | "items": { |
| 402 | "type": "string" |
| 403 | }, |
| 404 | "minItems": 1 |
| 405 | } |
| 406 | }, |
| 407 | "source": { |
| 408 | "type": "array", |
| 409 | "items": { |
| 410 | "type": "string", |
| 411 | "minLength": 1 |
| 412 | }, |
| 413 | "minItems": 1 |
| 414 | } |
| 415 | }, |
| 416 | "required": [ |
| 417 | "any_of" |
| 418 | ] |
| 419 | } |
| 420 | ] |
| 421 | } |
| 422 | }, |
| 423 | "source": { |
| 424 | "type": "array", |
| 425 | "items": { |
| 426 | "type": "string", |
| 427 | "minLength": 1 |
| 428 | }, |
| 429 | "minItems": 1 |
| 430 | } |
| 431 | }, |
| 432 | "required": [ |
| 433 | "all_of" |
| 434 | ], |
| 435 | "description": "Structured scope requirements for the tool. Null means the tool is legacy and only exposes flat scopes.", |
| 436 | "example": { |
| 437 | "all_of": [ |
| 438 | "read:user", |
| 439 | { |
| 440 | "any_of": [ |
| 441 | "repo", |
| 442 | "public_repo" |
| 443 | ] |
| 444 | } |
| 445 | ] |
| 446 | } |
| 447 | }, |
| 448 | "tags": { |
| 449 | "type": "array", |
| 450 | "items": { |
| 451 | "type": "string" |
| 452 | }, |
| 453 | "description": "List of tags associated with the tool for categorization and filtering", |
| 454 | "example": [ |
| 455 | "ci-cd", |
| 456 | "github", |
| 457 | "automation", |
| 458 | "devops" |
| 459 | ] |
| 460 | }, |
| 461 | "human_description": { |
| 462 | "type": "string", |
| 463 | "description": "Human-friendly description of the tool, if available", |
| 464 | "example": "Create a new issue in a GitHub repository" |
| 465 | }, |
| 466 | "is_deprecated": { |
| 467 | "type": "boolean", |
| 468 | "description": "Indicates if this tool is deprecated and may be removed in the future", |
| 469 | "example": false |
| 470 | }, |
| 471 | "deprecated": { |
| 472 | "type": "object", |
| 473 | "properties": { |
| 474 | "displayName": { |
| 475 | "type": "string", |
| 476 | "description": "The display name of the tool", |
| 477 | "example": "GitHub Actions" |
| 478 | }, |
| 479 | "version": { |
| 480 | "type": "string", |
| 481 | "description": "Current version identifier of the tool", |
| 482 | "example": "20250905_00" |
| 483 | }, |
| 484 | "available_versions": { |
| 485 | "type": "array", |
| 486 | "items": { |
| 487 | "type": "string" |
| 488 | }, |
| 489 | "description": "List of all available versions for this tool", |
| 490 | "example": [ |
| 491 | "20250905_00", |
| 492 | "20250906_00" |
| 493 | ] |
| 494 | }, |
| 495 | "is_deprecated": { |
| 496 | "type": "boolean", |
| 497 | "description": "Indicates if this tool is deprecated and may be removed in the future", |
| 498 | "example": false |
| 499 | }, |
| 500 | "toolkit": { |
| 501 | "type": "object", |
| 502 | "properties": { |
| 503 | "logo": { |
| 504 | "type": "string", |
| 505 | "description": "URL to the toolkit logo image", |
| 506 | "example": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png" |
| 507 | } |
| 508 | }, |
| 509 | "required": [ |
| 510 | "logo" |
| 511 | ] |
| 512 | } |
| 513 | }, |
| 514 | "required": [ |
| 515 | "displayName", |
| 516 | "version", |
| 517 | "available_versions", |
| 518 | "is_deprecated", |
| 519 | "toolkit" |
| 520 | ] |
| 521 | } |
| 522 | }, |
| 523 | "required": [ |
| 524 | "slug", |
| 525 | "name", |
| 526 | "description", |
| 527 | "toolkit", |
| 528 | "input_parameters", |
| 529 | "no_auth", |
| 530 | "available_versions", |
| 531 | "version", |
| 532 | "output_parameters", |
| 533 | "scopes", |
| 534 | "scope_requirements", |
| 535 | "tags", |
| 536 | "is_deprecated", |
| 537 | "deprecated" |
| 538 | ] |
| 539 | }, |
| 540 | "ToolsPaginated": { |
| 541 | "type": "object", |
| 542 | "properties": { |
| 543 | "items": { |
| 544 | "type": "array", |
| 545 | "items": { |
| 546 | "$ref": "#/components/schemas/Tool" |
| 547 | } |
| 548 | }, |
| 549 | "next_cursor": { |
| 550 | "type": "string", |
| 551 | "nullable": true |
| 552 | }, |
| 553 | "total_pages": { |
| 554 | "type": "number" |
| 555 | }, |
| 556 | "current_page": { |
| 557 | "type": "number" |
| 558 | }, |
| 559 | "total_items": { |
| 560 | "type": "number" |
| 561 | } |
| 562 | }, |
| 563 | "required": [ |
| 564 | "items", |
| 565 | "total_pages", |
| 566 | "current_page", |
| 567 | "total_items" |
| 568 | ] |
| 569 | }, |
| 570 | "ToolDetails": { |
| 571 | "type": "object", |
| 572 | "properties": { |
| 573 | "slug": { |
| 574 | "type": "string", |
| 575 | "description": "Unique identifier for the tool", |
| 576 | "example": "GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENT" |
| 577 | }, |
| 578 | "name": { |
| 579 | "type": "string", |
| 580 | "description": "Human-readable display name of the tool", |
| 581 | "example": "GitHub Actions" |
| 582 | }, |
| 583 | "description": { |
| 584 | "type": "string", |
| 585 | "description": "Detailed explanation of the tool's functionality and purpose", |
| 586 | "example": "Automate GitHub workflows including CI/CD, issue management, and release processes" |
| 587 | }, |
| 588 | "toolkit": { |
| 589 | "type": "object", |
| 590 | "properties": { |
| 591 | "slug": { |
| 592 | "type": "string", |
| 593 | "description": "Unique identifier of the parent toolkit", |
| 594 | "example": "github" |
| 595 | }, |
| 596 | "name": { |
| 597 | "type": "string", |
| 598 | "description": "Human-readable name of the parent toolkit", |
| 599 | "example": "GitHub" |
| 600 | }, |
| 601 | "logo": { |
| 602 | "type": "string", |
| 603 | "description": "URL to the toolkit logo image", |
| 604 | "example": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png" |
| 605 | } |
| 606 | }, |
| 607 | "required": [ |
| 608 | "slug", |
| 609 | "name", |
| 610 | "logo" |
| 611 | ] |
| 612 | }, |
| 613 | "input_parameters": { |
| 614 | "type": "object", |
| 615 | "additionalProperties": {}, |
| 616 | "description": "Schema definition of required input parameters for the tool", |
| 617 | "example": { |
| 618 | "repo_name": { |
| 619 | "type": "string", |
| 620 | "description": "GitHub repository name in owner/repo format", |
| 621 | "required": true, |
| 622 | "example": "octocat/Hello-World" |
| 623 | }, |
| 624 | "workflow_id": { |
| 625 | "type": "string", |
| 626 | "description": "ID or filename of the workflow to trigger", |
| 627 | "required": true, |
| 628 | "example": "main.yml" |
| 629 | } |
| 630 | } |
| 631 | }, |
| 632 | "no_auth": { |
| 633 | "type": "boolean", |
| 634 | "description": "Indicates if the tool can be used without authentication", |
| 635 | "example": false |
| 636 | }, |
| 637 | "available_versions": { |
| 638 | "type": "array", |
| 639 | "items": { |
| 640 | "type": "string" |
| 641 | }, |
| 642 | "description": "List of all available versions for this tool", |
| 643 | "example": [ |
| 644 | "20250905_00", |
| 645 | "20250906_00" |
| 646 | ] |
| 647 | }, |
| 648 | "version": { |
| 649 | "type": "string", |
| 650 | "description": "Current version of the tool", |
| 651 | "example": "20250905_00" |
| 652 | }, |
| 653 | "instant": { |
| 654 | "$ref": "#/components/schemas/InstantAccount" |
| 655 | }, |
| 656 | "output_parameters": { |
| 657 | "type": "object", |
| 658 | "additionalProperties": {}, |
| 659 | "description": "Schema definition of return values from the tool", |
| 660 | "example": { |
| 661 | "run_id": { |
| 662 | "type": "number", |
| 663 | "description": "ID of the workflow run that was triggered", |
| 664 | "example": 12345678 |
| 665 | }, |
| 666 | "status": { |
| 667 | "type": "string", |
| 668 | "description": "Status of the workflow run", |
| 669 | "example": "completed", |
| 670 | "enum": [ |
| 671 | "queued", |
| 672 | "in_progress", |
| 673 | "completed", |
| 674 | "failed" |
| 675 | ] |
| 676 | } |
| 677 | } |
| 678 | }, |
| 679 | "scopes": { |
| 680 | "type": "array", |
| 681 | "items": { |
| 682 | "type": "string" |
| 683 | }, |
| 684 | "description": "List of scopes associated with the tool", |
| 685 | "example": [ |
| 686 | "https://www.googleapis.com/auth/gmail.modify" |
| 687 | ] |
| 688 | }, |
| 689 | "scope_requirements": { |
| 690 | "type": "object", |
| 691 | "nullable": true, |
| 692 | "properties": { |
| 693 | "all_of": { |
| 694 | "type": "array", |
| 695 | "items": { |
| 696 | "anyOf": [ |
| 697 | { |
| 698 | "type": "string" |
| 699 | }, |
| 700 | { |
| 701 | "type": "object", |
| 702 | "properties": { |
| 703 | "any_of": { |
| 704 | "type": "array", |
| 705 | "items": { |
| 706 | "anyOf": [ |
| 707 | { |
| 708 | "type": "string" |
| 709 | }, |
| 710 | { |
| 711 | "type": "object", |
| 712 | "properties": { |
| 713 | "all_of": { |
| 714 | "type": "array", |
| 715 | "items": { |
| 716 | "type": "string" |
| 717 | }, |
| 718 | "minItems": 1 |
| 719 | }, |
| 720 | "source": { |
| 721 | "type": "array", |
| 722 | "items": { |
| 723 | "type": "string", |
| 724 | "minLength": 1 |
| 725 | }, |
| 726 | "minItems": 1 |
| 727 | } |
| 728 | }, |
| 729 | "required": [ |
| 730 | "all_of" |
| 731 | ] |
| 732 | } |
| 733 | ] |
| 734 | }, |
| 735 | "minItems": 1 |
| 736 | }, |
| 737 | "when": { |
| 738 | "type": "object", |
| 739 | "additionalProperties": { |
| 740 | "type": "array", |
| 741 | "items": { |
| 742 | "type": "string" |
| 743 | }, |
| 744 | "minItems": 1 |
| 745 | } |
| 746 | }, |
| 747 | "source": { |
| 748 | "type": "array", |
| 749 | "items": { |
| 750 | "type": "string", |
| 751 | "minLength": 1 |
| 752 | }, |
| 753 | "minItems": 1 |
| 754 | } |
| 755 | }, |
| 756 | "required": [ |
| 757 | "any_of" |
| 758 | ] |
| 759 | } |
| 760 | ] |
| 761 | } |
| 762 | }, |
| 763 | "source": { |
| 764 | "type": "array", |
| 765 | "items": { |
| 766 | "type": "string", |
| 767 | "minLength": 1 |
| 768 | }, |
| 769 | "minItems": 1 |
| 770 | } |
| 771 | }, |
| 772 | "required": [ |
| 773 | "all_of" |
| 774 | ], |
| 775 | "description": "Structured scope requirements for the tool. Null means the tool is legacy and only exposes flat scopes.", |
| 776 | "example": { |
| 777 | "all_of": [ |
| 778 | "read:user", |
| 779 | { |
| 780 | "any_of": [ |
| 781 | "repo", |
| 782 | "public_repo" |
| 783 | ] |
| 784 | } |
| 785 | ] |
| 786 | } |
| 787 | }, |
| 788 | "tags": { |
| 789 | "type": "array", |
| 790 | "items": { |
| 791 | "type": "string" |
| 792 | }, |
| 793 | "description": "List of tags associated with the tool for categorization and filtering", |
| 794 | "example": [ |
| 795 | "ci-cd", |
| 796 | "github", |
| 797 | "automation", |
| 798 | "devops" |
| 799 | ] |
| 800 | }, |
| 801 | "human_description": { |
| 802 | "type": "string", |
| 803 | "description": "Human-friendly description of the tool, if available", |
| 804 | "example": "Create a new issue in a GitHub repository" |
| 805 | }, |
| 806 | "is_deprecated": { |
| 807 | "type": "boolean", |
| 808 | "description": "Indicates if this tool is deprecated and may be removed in the future", |
| 809 | "example": false |
| 810 | }, |
| 811 | "deprecated": { |
| 812 | "type": "object", |
| 813 | "properties": { |
| 814 | "displayName": { |
| 815 | "type": "string", |
| 816 | "description": "The display name of the tool", |
| 817 | "example": "GitHub Actions" |
| 818 | }, |
| 819 | "version": { |
| 820 | "type": "string", |
| 821 | "description": "Current version identifier of the tool", |
| 822 | "example": "20250905_00" |
| 823 | }, |
| 824 | "available_versions": { |
| 825 | "type": "array", |
| 826 | "items": { |
| 827 | "type": "string" |
| 828 | }, |
| 829 | "description": "List of all available versions for this tool", |
| 830 | "example": [ |
| 831 | "20250905_00", |
| 832 | "20250906_00" |
| 833 | ] |
| 834 | }, |
| 835 | "is_deprecated": { |
| 836 | "type": "boolean", |
| 837 | "description": "Indicates if this tool is deprecated and may be removed in the future", |
| 838 | "example": false |
| 839 | }, |
| 840 | "toolkit": { |
| 841 | "type": "object", |
| 842 | "properties": { |
| 843 | "logo": { |
| 844 | "type": "string", |
| 845 | "description": "URL to the toolkit logo image", |
| 846 | "example": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png" |
| 847 | } |
| 848 | }, |
| 849 | "required": [ |
| 850 | "logo" |
| 851 | ] |
| 852 | } |
| 853 | }, |
| 854 | "required": [ |
| 855 | "displayName", |
| 856 | "version", |
| 857 | "available_versions", |
| 858 | "is_deprecated", |
| 859 | "toolkit" |
| 860 | ] |
| 861 | } |
| 862 | }, |
| 863 | "required": [ |
| 864 | "slug", |
| 865 | "name", |
| 866 | "description", |
| 867 | "toolkit", |
| 868 | "input_parameters", |
| 869 | "no_auth", |
| 870 | "available_versions", |
| 871 | "version", |
| 872 | "output_parameters", |
| 873 | "scopes", |
| 874 | "scope_requirements", |
| 875 | "tags", |
| 876 | "is_deprecated", |
| 877 | "deprecated" |
| 878 | ] |
| 879 | }, |
| 880 | "ToolRouterSessionV31ConfigHistoryListResponse": { |
| 881 | "type": "object", |
| 882 | "properties": { |
| 883 | "items": { |
| 884 | "type": "array", |
| 885 | "items": { |
| 886 | "type": "object", |
| 887 | "properties": { |
| 888 | "version": { |
| 889 | "type": "integer", |
| 890 | "description": "The config version this entry represents" |
| 891 | }, |
| 892 | "created_at": { |
| 893 | "type": "string", |
| 894 | "format": "date-time", |
| 895 | "description": "ISO timestamp. For history rows, when the entry was archived (i.e. the moment the version was superseded by a PATCH)." |
| 896 | }, |
| 897 | "config": { |
| 898 | "type": "object", |
| 899 | "properties": { |
| 900 | "user_id": { |
| 901 | "type": "string", |
| 902 | "description": "User identifier for this session" |
| 903 | }, |
| 904 | "toolkits": { |
| 905 | "anyOf": [ |
| 906 | { |
| 907 | "type": "object", |
| 908 | "properties": { |
| 909 | "enabled": { |
| 910 | "type": "array", |
| 911 | "items": { |
| 912 | "type": "string" |
| 913 | } |
| 914 | }, |
| 915 | "require_approval": { |
| 916 | "type": "array", |
| 917 | "items": { |
| 918 | "type": "string" |
| 919 | }, |
| 920 | "description": "Tool calls matched here pause until the user approves them.", |
| 921 | "x-experimental": true |
| 922 | } |
| 923 | }, |
| 924 | "required": [ |
| 925 | "enabled" |
| 926 | ], |
| 927 | "additionalProperties": false |
| 928 | }, |
| 929 | { |
| 930 | "type": "object", |
| 931 | "properties": { |
| 932 | "disabled": { |
| 933 | "type": "array", |
| 934 | "items": { |
| 935 | "type": "string" |
| 936 | } |
| 937 | }, |
| 938 | "require_approval": { |
| 939 | "type": "array", |
| 940 | "items": { |
| 941 | "type": "string" |
| 942 | }, |
| 943 | "description": "Tool calls matched here pause until the user approves them.", |
| 944 | "x-experimental": true |
| 945 | } |
| 946 | }, |
| 947 | "required": [ |
| 948 | "disabled" |
| 949 | ], |
| 950 | "additionalProperties": false |
| 951 | }, |
| 952 | { |
| 953 | "type": "object", |
| 954 | "properties": { |
| 955 | "require_approval": { |
| 956 | "type": "array", |
| 957 | "items": { |
| 958 | "type": "string" |
| 959 | }, |
| 960 | "description": "Tool calls matched here pause until the user approves them.", |
| 961 | "x-experimental": true |
| 962 | } |
| 963 | }, |
| 964 | "required": [ |
| 965 | "require_approval" |
| 966 | ], |
| 967 | "additionalProperties": false |
| 968 | } |
| 969 | ], |
| 970 | "description": "Toolkit configuration - either enabled list or disabled list, or toolkits whose tools need approval" |
| 971 | }, |
| 972 | "auth_configs": { |
| 973 | "type": "object", |
| 974 | "additionalProperties": { |
| 975 | "type": "string", |
| 976 | "format": "authConfigId" |
| 977 | }, |
| 978 | "description": "Auth config overrides per toolkit" |
| 979 | }, |
| 980 | "instant": { |
| 981 | "anyOf": [ |
| 982 | { |
| 983 | "type": "boolean", |
| 984 | "enum": [ |
| 985 | false |
| 986 | ] |
| 987 | }, |
| 988 | { |
| 989 | "type": "object", |
| 990 | "properties": { |
| 991 | "toolkits": { |
| 992 | "anyOf": [ |
| 993 | { |
| 994 | "type": "object", |
| 995 | "properties": { |
| 996 | "enabled": { |
| 997 | "type": "array", |
| 998 | "items": { |
| 999 | "type": "string" |
| 1000 | } |
| 1001 | } |
| 1002 | }, |
| 1003 | "required": [ |
| 1004 | "enabled" |
| 1005 | ], |
| 1006 | "additionalProperties": false |
| 1007 | }, |
| 1008 | { |
| 1009 | "type": "object", |
| 1010 | "properties": { |
| 1011 | "disabled": { |
| 1012 | "type": "array", |
| 1013 | "items": { |
| 1014 | "type": "string" |
| 1015 | } |
| 1016 | } |
| 1017 | }, |
| 1018 | "required": [ |
| 1019 | "disabled" |
| 1020 | ], |
| 1021 | "additionalProperties": false |
| 1022 | } |
| 1023 | ], |
| 1024 | "description": "Toolkits eligible for instant usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies." |
| 1025 | }, |
| 1026 | "tools": { |
| 1027 | "type": "object", |
| 1028 | "additionalProperties": { |
| 1029 | "anyOf": [ |
| 1030 | { |
| 1031 | "type": "object", |
| 1032 | "properties": { |
| 1033 | "enabled": { |
| 1034 | "type": "array", |
| 1035 | "items": { |
| 1036 | "type": "string" |
| 1037 | } |
| 1038 | } |
| 1039 | }, |
| 1040 | "required": [ |
| 1041 | "enabled" |
| 1042 | ], |
| 1043 | "additionalProperties": false |
| 1044 | }, |
| 1045 | { |
| 1046 | "type": "object", |
| 1047 | "properties": { |
| 1048 | "disabled": { |
| 1049 | "type": "array", |
| 1050 | "items": { |
| 1051 | "type": "string" |
| 1052 | } |
| 1053 | } |
| 1054 | }, |
| 1055 | "required": [ |
| 1056 | "disabled" |
| 1057 | ], |
| 1058 | "additionalProperties": false |
| 1059 | } |
| 1060 | ] |
| 1061 | }, |
| 1062 | "description": "Per-toolkit enabled or disabled lists that restrict instant usage. Toolkits absent from this map have no additional tool restriction." |
| 1063 | }, |
| 1064 | "return_instant_charge": { |
| 1065 | "type": "boolean", |
| 1066 | "description": "Whether session tool responses return a top-level instant_charge when a charge is available. Defaults to false; controls response visibility only." |
| 1067 | }, |
| 1068 | "return_prices_in_search": { |
| 1069 | "type": "boolean", |
| 1070 | "description": "Experimental. Whether tool search results show each instant tool's price, under instant_account.prices. Defaults to false.", |
| 1071 | "x-experimental": true |
| 1072 | } |
| 1073 | }, |
| 1074 | "required": [ |
| 1075 | "return_instant_charge", |
| 1076 | "return_prices_in_search" |
| 1077 | ], |
| 1078 | "additionalProperties": false |
| 1079 | } |
| 1080 | ], |
| 1081 | "description": "Instant usage settings. False disables instant usage; an object permits it subject to project permission and session toolkit and tool restrictions." |
| 1082 | }, |
| 1083 | "manage_connections": { |
| 1084 | "type": "object", |
| 1085 | "properties": { |
| 1086 | "enabled": { |
| 1087 | "type": "boolean", |
| 1088 | "default": true, |
| 1089 | "description": "Whether to enable the connection manager for automatic connection handling" |
| 1090 | }, |
| 1091 | "callback_url": { |
| 1092 | "type": "string", |
| 1093 | "format": "uri", |
| 1094 | "description": "Custom callback URL for connected account auth flows" |
| 1095 | }, |
| 1096 | "enable_wait_for_connections": { |
| 1097 | "type": "boolean", |
| 1098 | "default": false, |
| 1099 | "description": "Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status. Default false. May not work reliably with GPT models." |
| 1100 | }, |
| 1101 | "enable_connection_removal": { |
| 1102 | "type": "boolean", |
| 1103 | "default": true, |
| 1104 | "description": "Enable the \"remove\" action in COMPOSIO_MANAGE_CONNECTIONS. Default true." |
| 1105 | } |
| 1106 | }, |
| 1107 | "description": "Manage connections configuration" |
| 1108 | }, |
| 1109 | "tools": { |
| 1110 | "type": "object", |
| 1111 | "additionalProperties": { |
| 1112 | "anyOf": [ |
| 1113 | { |
| 1114 | "type": "object", |
| 1115 | "properties": { |
| 1116 | "enabled": { |
| 1117 | "type": "array", |
| 1118 | "items": { |
| 1119 | "type": "string" |
| 1120 | } |
| 1121 | }, |
| 1122 | "require_approval": { |
| 1123 | "type": "array", |
| 1124 | "items": { |
| 1125 | "type": "string" |
| 1126 | }, |
| 1127 | "description": "Tool calls matched here pause until the user approves them.", |
| 1128 | "x-experimental": true |
| 1129 | } |
| 1130 | }, |
| 1131 | "required": [ |
| 1132 | "enabled" |
| 1133 | ], |
| 1134 | "additionalProperties": false |
| 1135 | }, |
| 1136 | { |
| 1137 | "type": "object", |
| 1138 | "properties": { |
| 1139 | "disabled": { |
| 1140 | "type": "array", |
| 1141 | "items": { |
| 1142 | "type": "string" |
| 1143 | } |
| 1144 | }, |
| 1145 | "require_approval": { |
| 1146 | "type": "array", |
| 1147 | "items": { |
| 1148 | "type": "string" |
| 1149 | }, |
| 1150 | "description": "Tool calls matched here pause until the user approves them.", |
| 1151 | "x-experimental": true |
| 1152 | } |
| 1153 | }, |
| 1154 | "required": [ |
| 1155 | "disabled" |
| 1156 | ], |
| 1157 | "additionalProperties": false |
| 1158 | }, |
| 1159 | { |
| 1160 | "type": "object", |
| 1161 | "properties": { |
| 1162 | "tags": { |
| 1163 | "type": "object", |
| 1164 | "properties": { |
| 1165 | "enabled": { |
| 1166 | "type": "array", |
| 1167 | "items": { |
| 1168 | "type": "string", |
| 1169 | "enum": [ |
| 1170 | "readOnlyHint", |
| 1171 | "createHint", |
| 1172 | "updateHint", |
| 1173 | "destructiveHint", |
| 1174 | "idempotentHint", |
| 1175 | "openWorldHint" |
| 1176 | ] |
| 1177 | }, |
| 1178 | "description": "Tags that the tool must have at least one of" |
| 1179 | }, |
| 1180 | "disabled": { |
| 1181 | "type": "array", |
| 1182 | "items": { |
| 1183 | "type": "string", |
| 1184 | "enum": [ |
| 1185 | "readOnlyHint", |
| 1186 | "createHint", |
| 1187 | "updateHint", |
| 1188 | "destructiveHint", |
| 1189 | "idempotentHint", |
| 1190 | "openWorldHint" |
| 1191 | ] |
| 1192 | }, |
| 1193 | "description": "Tags that the tool must NOT have any of" |
| 1194 | }, |
| 1195 | "require_approval": { |
| 1196 | "type": "array", |
| 1197 | "items": { |
| 1198 | "type": "string", |
| 1199 | "enum": [ |
| 1200 | "readOnlyHint", |
| 1201 | "createHint", |
| 1202 | "updateHint", |
| 1203 | "destructiveHint", |
| 1204 | "idempotentHint", |
| 1205 | "openWorldHint" |
| 1206 | ] |
| 1207 | }, |
| 1208 | "description": "Tool calls matched here pause until the user approves them.", |
| 1209 | "x-experimental": true |
| 1210 | } |
| 1211 | } |
| 1212 | }, |
| 1213 | "require_approval": { |
| 1214 | "type": "array", |
| 1215 | "items": { |
| 1216 | "type": "string" |
| 1217 | }, |
| 1218 | "description": "Tool calls matched here pause until the user approves them.", |
| 1219 | "x-experimental": true |
| 1220 | } |
| 1221 | }, |
| 1222 | "required": [ |
| 1223 | "tags" |
| 1224 | ], |
| 1225 | "additionalProperties": false |
| 1226 | }, |
| 1227 | { |
| 1228 | "type": "object", |
| 1229 | "properties": { |
| 1230 | "require_approval": { |
| 1231 | "type": "array", |
| 1232 | "items": { |
| 1233 | "type": "string" |
| 1234 | }, |
| 1235 | "description": "Tool calls matched here pause until the user approves them.", |
| 1236 | "x-experimental": true |
| 1237 | } |
| 1238 | }, |
| 1239 | "required": [ |
| 1240 | "require_approval" |
| 1241 | ], |
| 1242 | "additionalProperties": false |
| 1243 | } |
| 1244 | ] |
| 1245 | }, |
| 1246 | "description": "Tool-level configuration per toolkit: tools to enable or disable, or tools that need approval" |
| 1247 | }, |
| 1248 | "tags": { |
| 1249 | "type": "object", |
| 1250 | "properties": { |
| 1251 | "enabled": { |
| 1252 | "type": "array", |
| 1253 | "items": { |
| 1254 | "type": "string", |
| 1255 | "enum": [ |
| 1256 | "readOnlyHint", |
| 1257 | "createHint", |
| 1258 | "updateHint", |
| 1259 | "destructiveHint", |
| 1260 | "idempotentHint", |
| 1261 | "openWorldHint" |
| 1262 | ] |
| 1263 | }, |
| 1264 | "description": "Tags that the tool must have at least one of" |
| 1265 | }, |
| 1266 | "disabled": { |
| 1267 | "type": "array", |
| 1268 | "items": { |
| 1269 | "type": "string", |
| 1270 | "enum": [ |
| 1271 | "readOnlyHint", |
| 1272 | "createHint", |
| 1273 | "updateHint", |
| 1274 | "destructiveHint", |
| 1275 | "idempotentHint", |
| 1276 | "openWorldHint" |
| 1277 | ] |
| 1278 | }, |
| 1279 | "description": "Tags that the tool must NOT have any of" |
| 1280 | }, |
| 1281 | "require_approval": { |
| 1282 | "type": "array", |
| 1283 | "items": { |
| 1284 | "type": "string", |
| 1285 | "enum": [ |
| 1286 | "readOnlyHint", |
| 1287 | "createHint", |
| 1288 | "updateHint", |
| 1289 | "destructiveHint", |
| 1290 | "idempotentHint", |
| 1291 | "openWorldHint" |
| 1292 | ] |
| 1293 | }, |
| 1294 | "description": "Tool calls matched here pause until the user approves them.", |
| 1295 | "x-experimental": true |
| 1296 | } |
| 1297 | }, |
| 1298 | "description": "MCP tool annotation hints for filtering tools with enabled/disabled support, and experimentally the tags whose tools need approval. enabled: tags that the tool must have at least one of. disabled: tags that the tool must NOT have any of. Both conditions must be satisfied." |
| 1299 | }, |
| 1300 | "workbench": { |
| 1301 | "type": "object", |
| 1302 | "properties": { |
| 1303 | "enable": { |
| 1304 | "type": "boolean", |
| 1305 | "description": "Whether the workbench (code execution sandbox) is enabled. When false, COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed." |
| 1306 | }, |
| 1307 | "tool_execution_enabled": { |
| 1308 | "type": "boolean", |
| 1309 | "description": "Whether tool execution is enabled in the workbench" |
| 1310 | }, |
| 1311 | "proxy_execution_enabled": { |
| 1312 | "type": "boolean", |
| 1313 | "description": "Whether proxy execution is enabled in the workbench" |
| 1314 | }, |
| 1315 | "auto_offload_threshold": { |
| 1316 | "type": "number", |
| 1317 | "minimum": 0, |
| 1318 | "exclusiveMinimum": true, |
| 1319 | "description": "Character threshold after which tool execution response are saved to a file in workbench. Default is 20k." |
| 1320 | }, |
| 1321 | "sandbox_size": { |
| 1322 | "type": "string", |
| 1323 | "enum": [ |
| 1324 | "standard", |
| 1325 | "medium", |
| 1326 | "large", |
| 1327 | "xlarge" |
| 1328 | ], |
| 1329 | "description": "Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4 vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Defaults to standard." |
| 1330 | } |
| 1331 | }, |
| 1332 | "default": { |
| 1333 | "enable": true, |
| 1334 | "proxy_execution_enabled": true |
| 1335 | }, |
| 1336 | "description": "Workbench configuration" |
| 1337 | }, |
| 1338 | "multi_account": { |
| 1339 | "type": "object", |
| 1340 | "properties": { |
| 1341 | "enable": { |
| 1342 | "type": "boolean", |
| 1343 | "description": "When true, enables multi-account mode for this session. When not set, falls back to org/project-level configuration." |
| 1344 | }, |
| 1345 | "max_accounts_per_toolkit": { |
| 1346 | "type": "integer", |
| 1347 | "description": "Maximum number of connected accounts allowed per toolkit. Defaults to 5 when multi-account is enabled." |
| 1348 | }, |
| 1349 | "require_explicit_selection": { |
| 1350 | "type": "boolean", |
| 1351 | "description": "When true, require explicit account selection when multiple accounts are connected. When false (default), use the first/default account." |
| 1352 | } |
| 1353 | }, |
| 1354 | "description": "Multi-account configuration for this session." |
| 1355 | }, |
| 1356 | "proxy_execute": { |
| 1357 | "type": "object", |
| 1358 | "properties": { |
| 1359 | "enable": { |
| 1360 | "type": "boolean", |
| 1361 | "description": "When true, enables proxy execute outside the workbench. When false, also disables proxy execution inside the workbench." |
| 1362 | } |
| 1363 | }, |
| 1364 | "required": [ |
| 1365 | "enable" |
| 1366 | ], |
| 1367 | "description": "Proxy execute configuration for this session. Omitted when not set." |
| 1368 | }, |
| 1369 | "hooks": { |
| 1370 | "type": "array", |
| 1371 | "items": { |
| 1372 | "oneOf": [ |
| 1373 | { |
| 1374 | "type": "object", |
| 1375 | "properties": { |
| 1376 | "type": { |
| 1377 | "type": "string", |
| 1378 | "enum": [ |
| 1379 | "before_execute" |
| 1380 | ] |
| 1381 | }, |
| 1382 | "id": { |
| 1383 | "type": "string", |
| 1384 | "pattern": "^[a-z0-9_-]{1,64}$", |
| 1385 | "description": "Unique within the session. Shows up in results and logs." |
| 1386 | }, |
| 1387 | "name": { |
| 1388 | "type": "string", |
| 1389 | "minLength": 1, |
| 1390 | "maxLength": 120, |
| 1391 | "description": "A readable name. The agent sees it when this hook blocks a call." |
| 1392 | }, |
| 1393 | "applies_to": { |
| 1394 | "anyOf": [ |
| 1395 | { |
| 1396 | "type": "string", |
| 1397 | "enum": [ |
| 1398 | "all" |
| 1399 | ] |
| 1400 | }, |
| 1401 | { |
| 1402 | "type": "object", |
| 1403 | "properties": { |
| 1404 | "toolkits": { |
| 1405 | "type": "array", |
| 1406 | "items": { |
| 1407 | "type": "string", |
| 1408 | "minLength": 1 |
| 1409 | }, |
| 1410 | "minItems": 1, |
| 1411 | "description": "Toolkit slugs" |
| 1412 | } |
| 1413 | }, |
| 1414 | "required": [ |
| 1415 | "toolkits" |
| 1416 | ], |
| 1417 | "additionalProperties": false |
| 1418 | } |
| 1419 | ], |
| 1420 | "description": "Which tools the hook covers: \"all\" for all of them, or only the listed toolkits." |
| 1421 | }, |
| 1422 | "handler": { |
| 1423 | "type": "object", |
| 1424 | "properties": { |
| 1425 | "type": { |
| 1426 | "type": "string", |
| 1427 | "enum": [ |
| 1428 | "condition_check" |
| 1429 | ] |
| 1430 | }, |
| 1431 | "condition": { |
| 1432 | "type": "string", |
| 1433 | "minLength": 1, |
| 1434 | "maxLength": 2000, |
| 1435 | "description": "What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\"." |
| 1436 | }, |
| 1437 | "action": { |
| 1438 | "type": "string", |
| 1439 | "enum": [ |
| 1440 | "block" |
| 1441 | ] |
| 1442 | } |
| 1443 | }, |
| 1444 | "required": [ |
| 1445 | "type", |
| 1446 | "condition", |
| 1447 | "action" |
| 1448 | ], |
| 1449 | "additionalProperties": false |
| 1450 | } |
| 1451 | }, |
| 1452 | "required": [ |
| 1453 | "type", |
| 1454 | "id", |
| 1455 | "applies_to", |
| 1456 | "handler" |
| 1457 | ], |
| 1458 | "additionalProperties": false |
| 1459 | }, |
| 1460 | { |
| 1461 | "type": "object", |
| 1462 | "properties": { |
| 1463 | "type": { |
| 1464 | "type": "string", |
| 1465 | "enum": [ |
| 1466 | "after_execute" |
| 1467 | ] |
| 1468 | }, |
| 1469 | "id": { |
| 1470 | "type": "string", |
| 1471 | "pattern": "^[a-z0-9_-]{1,64}$", |
| 1472 | "description": "Unique within the session. Shows up in results and logs." |
| 1473 | }, |
| 1474 | "name": { |
| 1475 | "type": "string", |
| 1476 | "minLength": 1, |
| 1477 | "maxLength": 120, |
| 1478 | "description": "A readable name. The agent sees it when this hook blocks a call." |
| 1479 | }, |
| 1480 | "applies_to": { |
| 1481 | "anyOf": [ |
| 1482 | { |
| 1483 | "type": "string", |
| 1484 | "enum": [ |
| 1485 | "all" |
| 1486 | ] |
| 1487 | }, |
| 1488 | { |
| 1489 | "type": "object", |
| 1490 | "properties": { |
| 1491 | "toolkits": { |
| 1492 | "type": "array", |
| 1493 | "items": { |
| 1494 | "type": "string", |
| 1495 | "minLength": 1 |
| 1496 | }, |
| 1497 | "minItems": 1, |
| 1498 | "description": "Toolkit slugs" |
| 1499 | } |
| 1500 | }, |
| 1501 | "required": [ |
| 1502 | "toolkits" |
| 1503 | ], |
| 1504 | "additionalProperties": false |
| 1505 | } |
| 1506 | ], |
| 1507 | "description": "Which tools the hook covers: \"all\" for all of them, or only the listed toolkits." |
| 1508 | }, |
| 1509 | "handler": { |
| 1510 | "oneOf": [ |
| 1511 | { |
| 1512 | "type": "object", |
| 1513 | "properties": { |
| 1514 | "type": { |
| 1515 | "type": "string", |
| 1516 | "enum": [ |
| 1517 | "condition_check" |
| 1518 | ] |
| 1519 | }, |
| 1520 | "condition": { |
| 1521 | "type": "string", |
| 1522 | "minLength": 1, |
| 1523 | "maxLength": 2000, |
| 1524 | "description": "What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\"." |
| 1525 | }, |
| 1526 | "action": { |
| 1527 | "type": "string", |
| 1528 | "enum": [ |
| 1529 | "block" |
| 1530 | ] |
| 1531 | } |
| 1532 | }, |
| 1533 | "required": [ |
| 1534 | "type", |
| 1535 | "condition", |
| 1536 | "action" |
| 1537 | ], |
| 1538 | "additionalProperties": false |
| 1539 | }, |
| 1540 | { |
| 1541 | "type": "object", |
| 1542 | "properties": { |
| 1543 | "type": { |
| 1544 | "type": "string", |
| 1545 | "enum": [ |
| 1546 | "prompt_injection_check" |
| 1547 | ] |
| 1548 | }, |
| 1549 | "action": { |
| 1550 | "type": "string", |
| 1551 | "enum": [ |
| 1552 | "block" |
| 1553 | ] |
| 1554 | } |
| 1555 | }, |
| 1556 | "required": [ |
| 1557 | "type", |
| 1558 | "action" |
| 1559 | ], |
| 1560 | "additionalProperties": false, |
| 1561 | "description": "Blocks a tool response that tries to manipulate the agent: override its instructions, change its role, or make it take actions the user didn't ask for." |
| 1562 | } |
| 1563 | ] |
| 1564 | } |
| 1565 | }, |
| 1566 | "required": [ |
| 1567 | "type", |
| 1568 | "id", |
| 1569 | "applies_to", |
| 1570 | "handler" |
| 1571 | ], |
| 1572 | "additionalProperties": false |
| 1573 | } |
| 1574 | ] |
| 1575 | }, |
| 1576 | "maxItems": 20, |
| 1577 | "description": "Hooks that run on this session's tool calls." |
| 1578 | }, |
| 1579 | "preload": { |
| 1580 | "type": "object", |
| 1581 | "properties": { |
| 1582 | "tools": { |
| 1583 | "anyOf": [ |
| 1584 | { |
| 1585 | "type": "array", |
| 1586 | "items": { |
| 1587 | "type": "string" |
| 1588 | } |
| 1589 | }, |
| 1590 | { |
| 1591 | "type": "string", |
| 1592 | "enum": [ |
| 1593 | "all" |
| 1594 | ] |
| 1595 | } |
| 1596 | ], |
| 1597 | "description": "Explicit preloaded tool slugs, or \"all\" when the session dynamically exposes all app tools allowed by its filters." |
| 1598 | } |
| 1599 | }, |
| 1600 | "required": [ |
| 1601 | "tools" |
| 1602 | ], |
| 1603 | "additionalProperties": false, |
| 1604 | "description": "Preload configuration. Explicit slugs are returned as an array; dynamic preload is returned as \"all\"." |
| 1605 | }, |
| 1606 | "connected_accounts": { |
| 1607 | "type": "object", |
| 1608 | "additionalProperties": { |
| 1609 | "type": "array", |
| 1610 | "items": { |
| 1611 | "type": "string", |
| 1612 | "format": "connectedAccountId" |
| 1613 | }, |
| 1614 | "minItems": 1 |
| 1615 | }, |
| 1616 | "description": "Per-toolkit connected account overrides (array of nano-IDs). Multi-account sessions can pin more than one account per toolkit; otherwise length is 1." |
| 1617 | }, |
| 1618 | "search": { |
| 1619 | "type": "object", |
| 1620 | "properties": { |
| 1621 | "enable": { |
| 1622 | "type": "boolean", |
| 1623 | "default": true |
| 1624 | } |
| 1625 | }, |
| 1626 | "description": "Search helper configuration" |
| 1627 | }, |
| 1628 | "execute": { |
| 1629 | "type": "object", |
| 1630 | "properties": { |
| 1631 | "enable_multi_execute": { |
| 1632 | "type": "boolean", |
| 1633 | "default": true |
| 1634 | } |
| 1635 | }, |
| 1636 | "description": "Execute helper configuration" |
| 1637 | } |
| 1638 | }, |
| 1639 | "required": [ |
| 1640 | "user_id", |
| 1641 | "instant", |
| 1642 | "preload", |
| 1643 | "search", |
| 1644 | "execute" |
| 1645 | ], |
| 1646 | "description": "The session configuration at this version" |
| 1647 | }, |
| 1648 | "is_current": { |
| 1649 | "type": "boolean", |
| 1650 | "description": "True only for the live (current) session config, present on the first page. False for archived history rows." |
| 1651 | } |
| 1652 | }, |
| 1653 | "required": [ |
| 1654 | "version", |
| 1655 | "created_at", |
| 1656 | "config", |
| 1657 | "is_current" |
| 1658 | ] |
| 1659 | } |
| 1660 | }, |
| 1661 | "next_cursor": { |
| 1662 | "type": "string", |
| 1663 | "nullable": true |
| 1664 | }, |
| 1665 | "total_pages": { |
| 1666 | "type": "number" |
| 1667 | }, |
| 1668 | "current_page": { |
| 1669 | "type": "number" |
| 1670 | }, |
| 1671 | "total_items": { |
| 1672 | "type": "number" |
| 1673 | } |
| 1674 | }, |
| 1675 | "required": [ |
| 1676 | "items", |
| 1677 | "total_pages", |
| 1678 | "current_page", |
| 1679 | "total_items" |
| 1680 | ] |
| 1681 | }, |
| 1682 | "HookResult": { |
| 1683 | "oneOf": [ |
| 1684 | { |
| 1685 | "type": "object", |
| 1686 | "properties": { |
| 1687 | "id": { |
| 1688 | "type": "string", |
| 1689 | "description": "The hook id" |
| 1690 | }, |
| 1691 | "status": { |
| 1692 | "type": "string", |
| 1693 | "enum": [ |
| 1694 | "evaluated" |
| 1695 | ] |
| 1696 | }, |
| 1697 | "outcome": { |
| 1698 | "type": "string", |
| 1699 | "enum": [ |
| 1700 | "continue", |
| 1701 | "block" |
| 1702 | ], |
| 1703 | "description": "What the hook decided" |
| 1704 | } |
| 1705 | }, |
| 1706 | "required": [ |
| 1707 | "id", |
| 1708 | "status", |
| 1709 | "outcome" |
| 1710 | ] |
| 1711 | }, |
| 1712 | { |
| 1713 | "type": "object", |
| 1714 | "properties": { |
| 1715 | "id": { |
| 1716 | "type": "string", |
| 1717 | "description": "The hook id" |
| 1718 | }, |
| 1719 | "status": { |
| 1720 | "type": "string", |
| 1721 | "enum": [ |
| 1722 | "unavailable" |
| 1723 | ], |
| 1724 | "description": "The hook could not be evaluated" |
| 1725 | } |
| 1726 | }, |
| 1727 | "required": [ |
| 1728 | "id", |
| 1729 | "status" |
| 1730 | ] |
| 1731 | } |
| 1732 | ] |
| 1733 | }, |
| 1734 | "ExecuteCompleted": { |
| 1735 | "type": "object", |
| 1736 | "properties": { |
| 1737 | "result_type": { |
| 1738 | "type": "string", |
| 1739 | "enum": [ |
| 1740 | "completed" |
| 1741 | ], |
| 1742 | "description": "The tool ran and succeeded", |
| 1743 | "x-experimental": true |
| 1744 | }, |
| 1745 | "instant_charge": { |
| 1746 | "type": "object", |
| 1747 | "properties": { |
| 1748 | "amount": { |
| 1749 | "type": "string", |
| 1750 | "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,12})?$", |
| 1751 | "description": "Instant charge in USD as an exact non-negative decimal string, with up to 12 fractional digits." |
| 1752 | }, |
| 1753 | "currency": { |
| 1754 | "type": "string", |
| 1755 | "enum": [ |
| 1756 | "USD" |
| 1757 | ], |
| 1758 | "description": "Currency of the instant charge. Always USD." |
| 1759 | }, |
| 1760 | "charged_by": { |
| 1761 | "type": "string", |
| 1762 | "enum": [ |
| 1763 | "composio" |
| 1764 | ], |
| 1765 | "description": "Entity charging for instant usage. Always composio." |
| 1766 | } |
| 1767 | }, |
| 1768 | "required": [ |
| 1769 | "amount", |
| 1770 | "currency", |
| 1771 | "charged_by" |
| 1772 | ], |
| 1773 | "description": "Returned only when the session enables instant.return_instant_charge and a charge is available. Failed individual tool calls omit it. Multi-execute returns one aggregate of reported charges from eligible successful calls, even if another call fails." |
| 1774 | }, |
| 1775 | "data": { |
| 1776 | "type": "object", |
| 1777 | "additionalProperties": {}, |
| 1778 | "description": "The data returned by the tool execution", |
| 1779 | "example": { |
| 1780 | "message": "Hello, World!", |
| 1781 | "status": "success" |
| 1782 | } |
| 1783 | }, |
| 1784 | "error": { |
| 1785 | "type": "string", |
| 1786 | "nullable": true, |
| 1787 | "description": "Error message if the execution failed, null otherwise" |
| 1788 | }, |
| 1789 | "log_id": { |
| 1790 | "type": "string", |
| 1791 | "description": "Unique identifier for the execution log", |
| 1792 | "example": "log_abc123xyz" |
| 1793 | }, |
| 1794 | "hook_results": { |
| 1795 | "type": "array", |
| 1796 | "items": { |
| 1797 | "$ref": "#/components/schemas/HookResult" |
| 1798 | }, |
| 1799 | "description": "Every session hook that applied to this call. Omitted when none applied." |
| 1800 | } |
| 1801 | }, |
| 1802 | "required": [ |
| 1803 | "result_type", |
| 1804 | "data", |
| 1805 | "error", |
| 1806 | "log_id" |
| 1807 | ] |
| 1808 | }, |
| 1809 | "ExecuteFailed": { |
| 1810 | "type": "object", |
| 1811 | "properties": { |
| 1812 | "result_type": { |
| 1813 | "type": "string", |
| 1814 | "enum": [ |
| 1815 | "failed" |
| 1816 | ], |
| 1817 | "description": "The tool ran and failed, or the user did not approve it", |
| 1818 | "x-experimental": true |
| 1819 | }, |
| 1820 | "instant_charge": { |
| 1821 | "type": "object", |
| 1822 | "properties": { |
| 1823 | "amount": { |
| 1824 | "type": "string", |
| 1825 | "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,12})?$", |
| 1826 | "description": "Instant charge in USD as an exact non-negative decimal string, with up to 12 fractional digits." |
| 1827 | }, |
| 1828 | "currency": { |
| 1829 | "type": "string", |
| 1830 | "enum": [ |
| 1831 | "USD" |
| 1832 | ], |
| 1833 | "description": "Currency of the instant charge. Always USD." |
| 1834 | }, |
| 1835 | "charged_by": { |
| 1836 | "type": "string", |
| 1837 | "enum": [ |
| 1838 | "composio" |
| 1839 | ], |
| 1840 | "description": "Entity charging for instant usage. Always composio." |
| 1841 | } |
| 1842 | }, |
| 1843 | "required": [ |
| 1844 | "amount", |
| 1845 | "currency", |
| 1846 | "charged_by" |
| 1847 | ], |
| 1848 | "description": "Returned only when the session enables instant.return_instant_charge and a charge is available. Failed individual tool calls omit it. Multi-execute returns one aggregate of reported charges from eligible successful calls, even if another call fails." |
| 1849 | }, |
| 1850 | "data": { |
| 1851 | "type": "object", |
| 1852 | "additionalProperties": {}, |
| 1853 | "description": "The data returned by the tool execution", |
| 1854 | "example": { |
| 1855 | "message": "Hello, World!", |
| 1856 | "status": "success" |
| 1857 | } |
| 1858 | }, |
| 1859 | "error": { |
| 1860 | "type": "string", |
| 1861 | "nullable": true, |
| 1862 | "description": "Error message if the execution failed, null otherwise" |
| 1863 | }, |
| 1864 | "log_id": { |
| 1865 | "type": "string", |
| 1866 | "description": "Unique identifier for the execution log", |
| 1867 | "example": "log_abc123xyz" |
| 1868 | }, |
| 1869 | "hook_results": { |
| 1870 | "type": "array", |
| 1871 | "items": { |
| 1872 | "$ref": "#/components/schemas/HookResult" |
| 1873 | }, |
| 1874 | "description": "Every session hook that applied to this call. Omitted when none applied." |
| 1875 | } |
| 1876 | }, |
| 1877 | "required": [ |
| 1878 | "result_type", |
| 1879 | "data", |
| 1880 | "error", |
| 1881 | "log_id" |
| 1882 | ] |
| 1883 | }, |
| 1884 | "BlockReason": { |
| 1885 | "oneOf": [ |
| 1886 | { |
| 1887 | "type": "object", |
| 1888 | "properties": { |
| 1889 | "type": { |
| 1890 | "type": "string", |
| 1891 | "enum": [ |
| 1892 | "request_blocked" |
| 1893 | ], |
| 1894 | "description": "A before_execute hook stopped the call. The tool did not run." |
| 1895 | }, |
| 1896 | "hook_id": { |
| 1897 | "type": "string" |
| 1898 | } |
| 1899 | }, |
| 1900 | "required": [ |
| 1901 | "type", |
| 1902 | "hook_id" |
| 1903 | ] |
| 1904 | }, |
| 1905 | { |
| 1906 | "type": "object", |
| 1907 | "properties": { |
| 1908 | "type": { |
| 1909 | "type": "string", |
| 1910 | "enum": [ |
| 1911 | "response_blocked" |
| 1912 | ], |
| 1913 | "description": "An after_execute hook stopped the call. The tool ran; its response was withheld." |
| 1914 | }, |
| 1915 | "hook_id": { |
| 1916 | "type": "string" |
| 1917 | } |
| 1918 | }, |
| 1919 | "required": [ |
| 1920 | "type", |
| 1921 | "hook_id" |
| 1922 | ] |
| 1923 | } |
| 1924 | ] |
| 1925 | }, |
| 1926 | "ExecuteBlocked": { |
| 1927 | "type": "object", |
| 1928 | "properties": { |
| 1929 | "result_type": { |
| 1930 | "type": "string", |
| 1931 | "enum": [ |
| 1932 | "blocked" |
| 1933 | ], |
| 1934 | "description": "A session hook stopped the call" |
| 1935 | }, |
| 1936 | "reason": { |
| 1937 | "$ref": "#/components/schemas/BlockReason" |
| 1938 | }, |
| 1939 | "message": { |
| 1940 | "type": "string", |
| 1941 | "description": "A message for the agent. It includes the hook's name, when it has one; the hook id is in `reason`.", |
| 1942 | "example": "Blocked by session policy: No external email" |
| 1943 | }, |
| 1944 | "log_id": { |
| 1945 | "type": "string", |
| 1946 | "description": "The execution log ID. Only set when the tool ran and its response was blocked." |
| 1947 | }, |
| 1948 | "instant_charge": { |
| 1949 | "type": "object", |
| 1950 | "properties": { |
| 1951 | "amount": { |
| 1952 | "type": "string", |
| 1953 | "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,12})?$", |
| 1954 | "description": "Instant charge in USD as an exact non-negative decimal string, with up to 12 fractional digits." |
| 1955 | }, |
| 1956 | "currency": { |
| 1957 | "type": "string", |
| 1958 | "enum": [ |
| 1959 | "USD" |
| 1960 | ], |
| 1961 | "description": "Currency of the instant charge. Always USD." |
| 1962 | }, |
| 1963 | "charged_by": { |
| 1964 | "type": "string", |
| 1965 | "enum": [ |
| 1966 | "composio" |
| 1967 | ], |
| 1968 | "description": "Entity charging for instant usage. Always composio." |
| 1969 | } |
| 1970 | }, |
| 1971 | "required": [ |
| 1972 | "amount", |
| 1973 | "currency", |
| 1974 | "charged_by" |
| 1975 | ], |
| 1976 | "description": "Returned only when the session enables instant.return_instant_charge and a charge is available. Only set when the tool ran and its response was blocked." |
| 1977 | }, |
| 1978 | "hook_results": { |
| 1979 | "type": "array", |
| 1980 | "items": { |
| 1981 | "$ref": "#/components/schemas/HookResult" |
| 1982 | }, |
| 1983 | "description": "Every session hook that applied to this call. Omitted when none applied." |
| 1984 | } |
| 1985 | }, |
| 1986 | "required": [ |
| 1987 | "result_type", |
| 1988 | "reason", |
| 1989 | "message" |
| 1990 | ] |
| 1991 | }, |
| 1992 | "UserInputRequest": { |
| 1993 | "type": "object", |
| 1994 | "properties": { |
| 1995 | "type": { |
| 1996 | "type": "string", |
| 1997 | "enum": [ |
| 1998 | "elicitation" |
| 1999 | ], |
| 2000 | "description": "Always `elicitation`" |
| 2001 | }, |
| 2002 | "mode": { |
| 2003 | "type": "string", |
| 2004 | "enum": [ |
| 2005 | "form" |
| 2006 | ], |
| 2007 | "description": "Always `form`: collect the answer with a form built from `requested_schema`" |
| 2008 | }, |
| 2009 | "message": { |
| 2010 | "type": "string", |
| 2011 | "description": "Text to show the user", |
| 2012 | "example": "Your agent wants to run the following tool:\n\nGITHUB_DELETE_A_REPOSITORY({\"owner\": \"acme\", \"repo\": \"old-api\"})" |
| 2013 | }, |
| 2014 | "requested_schema": { |
| 2015 | "type": "object", |
| 2016 | "additionalProperties": {}, |
| 2017 | "description": "JSON Schema for the answer. As in MCP form mode, it is a flat object whose fields are strings, numbers, booleans, or single- or multi-select enums." |
| 2018 | } |
| 2019 | }, |
| 2020 | "required": [ |
| 2021 | "type", |
| 2022 | "mode", |
| 2023 | "message", |
| 2024 | "requested_schema" |
| 2025 | ], |
| 2026 | "description": "A question for the user, in the shape of an MCP `elicitation/create` request in form mode (https://modelcontextprotocol.io/specification/2026-07-28/client/elicitation). Show `message` to the user and collect an answer that matches `requested_schema`." |
| 2027 | }, |
| 2028 | "ExecuteRequiresUserInput": { |
| 2029 | "type": "object", |
| 2030 | "properties": { |
| 2031 | "result_type": { |
| 2032 | "type": "string", |
| 2033 | "enum": [ |
| 2034 | "input_required" |
| 2035 | ], |
| 2036 | "description": "The call needs the user's input before it runs", |
| 2037 | "x-experimental": true |
| 2038 | }, |
| 2039 | "input_requests": { |
| 2040 | "type": "object", |
| 2041 | "additionalProperties": { |
| 2042 | "$ref": "#/components/schemas/UserInputRequest" |
| 2043 | }, |
| 2044 | "description": "Questions for the user, keyed by an ID the answers must reuse", |
| 2045 | "x-experimental": true |
| 2046 | }, |
| 2047 | "request_state": { |
| 2048 | "type": "string", |
| 2049 | "description": "Send this back unchanged in `request_state` with the answers", |
| 2050 | "x-experimental": true |
| 2051 | } |
| 2052 | }, |
| 2053 | "required": [ |
| 2054 | "result_type", |
| 2055 | "input_requests" |
| 2056 | ], |
| 2057 | "description": "The call needs the user's input before it runs. Returned only when the session is configured to ask for user approval before tool execution. Show each question in `input_requests` to the user, then repeat the same call with their answers in `input_responses`, along with this `request_state` if present.", |
| 2058 | "x-experimental": true |
| 2059 | }, |
| 2060 | "UserInputResponse": { |
| 2061 | "type": "object", |
| 2062 | "properties": { |
| 2063 | "action": { |
| 2064 | "type": "string", |
| 2065 | "enum": [ |
| 2066 | "accept", |
| 2067 | "decline", |
| 2068 | "cancel" |
| 2069 | ], |
| 2070 | "description": "`accept` when the user submitted the form, `decline` when they said no, `cancel` when they dismissed it" |
| 2071 | }, |
| 2072 | "content": { |
| 2073 | "type": "object", |
| 2074 | "additionalProperties": {}, |
| 2075 | "description": "With `accept`, the user's answer: fields matching the question's `requested_schema`" |
| 2076 | } |
| 2077 | }, |
| 2078 | "required": [ |
| 2079 | "action" |
| 2080 | ], |
| 2081 | "description": "The user's answer to one question, in the shape of an MCP elicitation result (https://modelcontextprotocol.io/specification/2026-07-28/client/elicitation)." |
| 2082 | }, |
| 2083 | "ComposioManagedAuthConfigCreate": { |
| 2084 | "type": "object", |
| 2085 | "properties": { |
| 2086 | "type": { |
| 2087 | "type": "string", |
| 2088 | "enum": [ |
| 2089 | "use_composio_managed_auth" |
| 2090 | ] |
| 2091 | }, |
| 2092 | "name": { |
| 2093 | "type": "string", |
| 2094 | "maxLength": 255, |
| 2095 | "description": "The name of the integration" |
| 2096 | }, |
| 2097 | "managed_app_id": { |
| 2098 | "type": "string", |
| 2099 | "format": "managedAppId", |
| 2100 | "description": "The Composio-managed app to use, as composio_managed_auth[].managed_app_id from GET /api/v3/toolkits/{toolkit_slug}. Omit to use the toolkit's default app." |
| 2101 | }, |
| 2102 | "credentials": { |
| 2103 | "type": "object", |
| 2104 | "properties": { |
| 2105 | "scopes": { |
| 2106 | "anyOf": [ |
| 2107 | { |
| 2108 | "type": "string" |
| 2109 | }, |
| 2110 | { |
| 2111 | "type": "array", |
| 2112 | "items": { |
| 2113 | "type": "string" |
| 2114 | } |
| 2115 | } |
| 2116 | ], |
| 2117 | "description": "OAuth scopes requested for the managed auth config." |
| 2118 | }, |
| 2119 | "user_scopes": { |
| 2120 | "anyOf": [ |
| 2121 | { |
| 2122 | "type": "string" |
| 2123 | }, |
| 2124 | { |
| 2125 | "type": "array", |
| 2126 | "items": { |
| 2127 | "type": "string" |
| 2128 | } |
| 2129 | } |
| 2130 | ], |
| 2131 | "description": "OAuth user-token scopes requested for the managed auth config. This is primarily used by Slack OAuth v2." |
| 2132 | } |
| 2133 | }, |
| 2134 | "default": {} |
| 2135 | }, |
| 2136 | "tool_access_config": { |
| 2137 | "type": "object", |
| 2138 | "properties": { |
| 2139 | "tools_for_connected_account_creation": { |
| 2140 | "type": "array", |
| 2141 | "items": { |
| 2142 | "type": "string" |
| 2143 | }, |
| 2144 | "default": [], |
| 2145 | "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2146 | "deprecated": true |
| 2147 | } |
| 2148 | }, |
| 2149 | "description": "DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2150 | "deprecated": true |
| 2151 | }, |
| 2152 | "restrict_to_following_tools": { |
| 2153 | "type": "array", |
| 2154 | "items": { |
| 2155 | "type": "string" |
| 2156 | }, |
| 2157 | "default": [], |
| 2158 | "description": "List of tool slugs this auth config is restricted to use with. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2159 | "deprecated": true |
| 2160 | }, |
| 2161 | "shared_credentials": { |
| 2162 | "type": "object", |
| 2163 | "additionalProperties": {}, |
| 2164 | "description": "Shared credentials that will be inherited by all connected accounts using this auth config. DEPRECATED: use `shared_connection_fields` instead. It takes the same value and behaves the same way.", |
| 2165 | "deprecated": true |
| 2166 | }, |
| 2167 | "shared_connection_fields": { |
| 2168 | "type": "object", |
| 2169 | "additionalProperties": {}, |
| 2170 | "description": "Connection field values inherited by every connected account created under this auth config (for example a region or subdomain). Non-secret values pre-fill the hosted Connect Link form; secret values are redacted in responses and never sent to the end user." |
| 2171 | }, |
| 2172 | "is_enabled_for_tool_router": { |
| 2173 | "type": "boolean", |
| 2174 | "description": "Whether this auth config is enabled for tool router" |
| 2175 | } |
| 2176 | }, |
| 2177 | "required": [ |
| 2178 | "type" |
| 2179 | ] |
| 2180 | }, |
| 2181 | "CustomAuthConfigCreate": { |
| 2182 | "type": "object", |
| 2183 | "properties": { |
| 2184 | "type": { |
| 2185 | "type": "string", |
| 2186 | "enum": [ |
| 2187 | "use_custom_auth" |
| 2188 | ] |
| 2189 | }, |
| 2190 | "name": { |
| 2191 | "type": "string", |
| 2192 | "maxLength": 255, |
| 2193 | "description": "The name of the integration" |
| 2194 | }, |
| 2195 | "authScheme": { |
| 2196 | "type": "string", |
| 2197 | "enum": [ |
| 2198 | "OAUTH2", |
| 2199 | "OAUTH1", |
| 2200 | "API_KEY", |
| 2201 | "BASIC", |
| 2202 | "BILLCOM_AUTH", |
| 2203 | "BEARER_TOKEN", |
| 2204 | "GOOGLE_SERVICE_ACCOUNT", |
| 2205 | "NO_AUTH", |
| 2206 | "BASIC_WITH_JWT", |
| 2207 | "CALCOM_AUTH", |
| 2208 | "SERVICE_ACCOUNT", |
| 2209 | "SAML", |
| 2210 | "DCR_OAUTH", |
| 2211 | "CIMD_OAUTH", |
| 2212 | "S2S_OAUTH2" |
| 2213 | ] |
| 2214 | }, |
| 2215 | "credentials": { |
| 2216 | "type": "object", |
| 2217 | "properties": { |
| 2218 | "scopes": { |
| 2219 | "anyOf": [ |
| 2220 | { |
| 2221 | "type": "string" |
| 2222 | }, |
| 2223 | { |
| 2224 | "type": "array", |
| 2225 | "items": { |
| 2226 | "type": "string" |
| 2227 | } |
| 2228 | } |
| 2229 | ], |
| 2230 | "description": "OAuth scopes requested for the custom auth config." |
| 2231 | }, |
| 2232 | "user_scopes": { |
| 2233 | "anyOf": [ |
| 2234 | { |
| 2235 | "type": "string" |
| 2236 | }, |
| 2237 | { |
| 2238 | "type": "array", |
| 2239 | "items": { |
| 2240 | "type": "string" |
| 2241 | } |
| 2242 | } |
| 2243 | ], |
| 2244 | "description": "OAuth user-token scopes requested for the custom auth config. This is primarily used by Slack OAuth v2." |
| 2245 | } |
| 2246 | }, |
| 2247 | "default": {} |
| 2248 | }, |
| 2249 | "sealed_credentials": { |
| 2250 | "type": "object", |
| 2251 | "additionalProperties": { |
| 2252 | "type": "string", |
| 2253 | "minLength": 1, |
| 2254 | "maxLength": 16384 |
| 2255 | }, |
| 2256 | "description": "[EXPERIMENTAL] Client-sealed secret fields to redeem through the organization keyring instance (GET /api/v3.1/keyring/transfer_keys). The plaintext must not also appear in credentials.", |
| 2257 | "x-experimental": true |
| 2258 | }, |
| 2259 | "proxy_config": { |
| 2260 | "type": "object", |
| 2261 | "nullable": true, |
| 2262 | "properties": { |
| 2263 | "proxy_url": { |
| 2264 | "type": "string", |
| 2265 | "format": "uri", |
| 2266 | "description": "The url of the auth proxy" |
| 2267 | }, |
| 2268 | "proxy_auth_key": { |
| 2269 | "type": "string", |
| 2270 | "description": "The auth key for the auth proxy" |
| 2271 | } |
| 2272 | }, |
| 2273 | "required": [ |
| 2274 | "proxy_url" |
| 2275 | ] |
| 2276 | }, |
| 2277 | "restrict_to_following_tools": { |
| 2278 | "type": "array", |
| 2279 | "items": { |
| 2280 | "type": "string" |
| 2281 | }, |
| 2282 | "default": [], |
| 2283 | "description": "List of tool slugs this auth config is restricted to use with. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2284 | "deprecated": true |
| 2285 | }, |
| 2286 | "tool_access_config": { |
| 2287 | "type": "object", |
| 2288 | "properties": { |
| 2289 | "tools_for_connected_account_creation": { |
| 2290 | "type": "array", |
| 2291 | "items": { |
| 2292 | "type": "string" |
| 2293 | }, |
| 2294 | "default": [], |
| 2295 | "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2296 | "deprecated": true |
| 2297 | } |
| 2298 | }, |
| 2299 | "description": "DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2300 | "deprecated": true |
| 2301 | }, |
| 2302 | "shared_credentials": { |
| 2303 | "type": "object", |
| 2304 | "additionalProperties": {}, |
| 2305 | "description": "Shared credentials that will be inherited by all connected accounts using this auth config. DEPRECATED: use `shared_connection_fields` instead. It takes the same value and behaves the same way.", |
| 2306 | "deprecated": true |
| 2307 | }, |
| 2308 | "shared_connection_fields": { |
| 2309 | "type": "object", |
| 2310 | "additionalProperties": {}, |
| 2311 | "description": "Connection field values inherited by every connected account created under this auth config (for example a region or subdomain). Non-secret values pre-fill the hosted Connect Link form; secret values are redacted in responses and never sent to the end user." |
| 2312 | }, |
| 2313 | "is_enabled_for_tool_router": { |
| 2314 | "type": "boolean", |
| 2315 | "description": "Whether this auth config is enabled for tool router" |
| 2316 | } |
| 2317 | }, |
| 2318 | "required": [ |
| 2319 | "type", |
| 2320 | "authScheme" |
| 2321 | ] |
| 2322 | }, |
| 2323 | "CustomAuthConfigUpdate": { |
| 2324 | "type": "object", |
| 2325 | "properties": { |
| 2326 | "type": { |
| 2327 | "type": "string", |
| 2328 | "enum": [ |
| 2329 | "custom" |
| 2330 | ] |
| 2331 | }, |
| 2332 | "name": { |
| 2333 | "type": "string", |
| 2334 | "minLength": 1, |
| 2335 | "maxLength": 255, |
| 2336 | "description": "The display name of the authentication configuration" |
| 2337 | }, |
| 2338 | "credentials": { |
| 2339 | "type": "object", |
| 2340 | "properties": { |
| 2341 | "scopes": { |
| 2342 | "anyOf": [ |
| 2343 | { |
| 2344 | "type": "string" |
| 2345 | }, |
| 2346 | { |
| 2347 | "type": "array", |
| 2348 | "items": { |
| 2349 | "type": "string" |
| 2350 | } |
| 2351 | } |
| 2352 | ], |
| 2353 | "description": "OAuth scopes requested for the auth config." |
| 2354 | }, |
| 2355 | "user_scopes": { |
| 2356 | "anyOf": [ |
| 2357 | { |
| 2358 | "type": "string" |
| 2359 | }, |
| 2360 | { |
| 2361 | "type": "array", |
| 2362 | "items": { |
| 2363 | "type": "string" |
| 2364 | } |
| 2365 | } |
| 2366 | ], |
| 2367 | "description": "OAuth user-token scopes requested for the auth config. This is primarily used by Slack OAuth v2." |
| 2368 | } |
| 2369 | } |
| 2370 | }, |
| 2371 | "sealed_credentials": { |
| 2372 | "type": "object", |
| 2373 | "additionalProperties": { |
| 2374 | "type": "string", |
| 2375 | "minLength": 1, |
| 2376 | "maxLength": 16384 |
| 2377 | }, |
| 2378 | "description": "[EXPERIMENTAL] Client-sealed secret fields to redeem through the organization keyring instance (GET /api/v3.1/keyring/transfer_keys). The plaintext must not also appear in credentials. Rotates the stored client_secret without Composio ever holding it.", |
| 2379 | "x-experimental": true |
| 2380 | }, |
| 2381 | "proxy_config": { |
| 2382 | "type": "object", |
| 2383 | "nullable": true, |
| 2384 | "properties": { |
| 2385 | "proxy_url": { |
| 2386 | "type": "string", |
| 2387 | "format": "uri", |
| 2388 | "description": "The url of the auth proxy" |
| 2389 | }, |
| 2390 | "proxy_auth_key": { |
| 2391 | "type": "string", |
| 2392 | "description": "The auth key for the auth proxy" |
| 2393 | } |
| 2394 | }, |
| 2395 | "required": [ |
| 2396 | "proxy_url" |
| 2397 | ] |
| 2398 | }, |
| 2399 | "restrict_to_following_tools": { |
| 2400 | "type": "array", |
| 2401 | "items": { |
| 2402 | "type": "string" |
| 2403 | }, |
| 2404 | "description": "List of tool slugs this auth config is restricted to use with. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2405 | "deprecated": true |
| 2406 | }, |
| 2407 | "tool_access_config": { |
| 2408 | "type": "object", |
| 2409 | "properties": { |
| 2410 | "tools_for_connected_account_creation": { |
| 2411 | "type": "array", |
| 2412 | "items": { |
| 2413 | "type": "string" |
| 2414 | }, |
| 2415 | "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2416 | "deprecated": true |
| 2417 | }, |
| 2418 | "tools_available_for_execution": { |
| 2419 | "type": "array", |
| 2420 | "items": { |
| 2421 | "type": "string" |
| 2422 | }, |
| 2423 | "description": "The actions that the user can perform on the auth config. If passed, this will update the actions that the user can perform on the auth config. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2424 | "deprecated": true |
| 2425 | } |
| 2426 | }, |
| 2427 | "description": "DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2428 | "deprecated": true |
| 2429 | }, |
| 2430 | "shared_credentials": { |
| 2431 | "type": "object", |
| 2432 | "additionalProperties": {}, |
| 2433 | "description": "Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged. DEPRECATED: use `shared_connection_fields` instead. It takes the same value and behaves the same way.", |
| 2434 | "deprecated": true |
| 2435 | }, |
| 2436 | "shared_connection_fields": { |
| 2437 | "type": "object", |
| 2438 | "additionalProperties": {}, |
| 2439 | "description": "Connection field values inherited by every connected account created under this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged." |
| 2440 | }, |
| 2441 | "is_enabled_for_tool_router": { |
| 2442 | "type": "boolean", |
| 2443 | "description": "Whether this auth config is enabled for tool router" |
| 2444 | } |
| 2445 | }, |
| 2446 | "required": [ |
| 2447 | "type" |
| 2448 | ] |
| 2449 | }, |
| 2450 | "DefaultAuthConfigUpdate": { |
| 2451 | "type": "object", |
| 2452 | "properties": { |
| 2453 | "type": { |
| 2454 | "type": "string", |
| 2455 | "enum": [ |
| 2456 | "default" |
| 2457 | ] |
| 2458 | }, |
| 2459 | "name": { |
| 2460 | "type": "string", |
| 2461 | "minLength": 1, |
| 2462 | "maxLength": 255, |
| 2463 | "description": "The display name of the authentication configuration" |
| 2464 | }, |
| 2465 | "scopes": { |
| 2466 | "anyOf": [ |
| 2467 | { |
| 2468 | "type": "string" |
| 2469 | }, |
| 2470 | { |
| 2471 | "type": "array", |
| 2472 | "items": { |
| 2473 | "type": "string" |
| 2474 | } |
| 2475 | } |
| 2476 | ], |
| 2477 | "description": "OAuth scopes requested for the auth config." |
| 2478 | }, |
| 2479 | "user_scopes": { |
| 2480 | "anyOf": [ |
| 2481 | { |
| 2482 | "type": "string" |
| 2483 | }, |
| 2484 | { |
| 2485 | "type": "array", |
| 2486 | "items": { |
| 2487 | "type": "string" |
| 2488 | } |
| 2489 | } |
| 2490 | ], |
| 2491 | "description": "OAuth user-token scopes requested for the auth config. This is primarily used by Slack OAuth v2." |
| 2492 | }, |
| 2493 | "restrict_to_following_tools": { |
| 2494 | "type": "array", |
| 2495 | "items": { |
| 2496 | "type": "string" |
| 2497 | }, |
| 2498 | "description": "List of tool slugs this auth config is restricted to use with. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2499 | "deprecated": true |
| 2500 | }, |
| 2501 | "tool_access_config": { |
| 2502 | "type": "object", |
| 2503 | "properties": { |
| 2504 | "tools_for_connected_account_creation": { |
| 2505 | "type": "array", |
| 2506 | "items": { |
| 2507 | "type": "string" |
| 2508 | }, |
| 2509 | "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2510 | "deprecated": true |
| 2511 | }, |
| 2512 | "tools_available_for_execution": { |
| 2513 | "type": "array", |
| 2514 | "items": { |
| 2515 | "type": "string" |
| 2516 | }, |
| 2517 | "description": "The actions that the user can perform on the auth config. If passed, this will update the actions that the user can perform on the auth config. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2518 | "deprecated": true |
| 2519 | } |
| 2520 | }, |
| 2521 | "description": "DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.", |
| 2522 | "deprecated": true |
| 2523 | }, |
| 2524 | "shared_credentials": { |
| 2525 | "type": "object", |
| 2526 | "additionalProperties": {}, |
| 2527 | "description": "Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged. DEPRECATED: use `shared_connection_fields` instead. It takes the same value and behaves the same way.", |
| 2528 | "deprecated": true |
| 2529 | }, |
| 2530 | "shared_connection_fields": { |
| 2531 | "type": "object", |
| 2532 | "additionalProperties": {}, |
| 2533 | "description": "Connection field values inherited by every connected account created under this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged." |
| 2534 | }, |
| 2535 | "is_enabled_for_tool_router": { |
| 2536 | "type": "boolean", |
| 2537 | "description": "Whether this auth config is enabled for tool router" |
| 2538 | } |
| 2539 | }, |
| 2540 | "required": [ |
| 2541 | "type" |
| 2542 | ] |
| 2543 | }, |
| 2544 | "PatchConnectedAccountBody": { |
| 2545 | "type": "object", |
| 2546 | "properties": { |
| 2547 | "alias": { |
| 2548 | "type": "string", |
| 2549 | "maxLength": 255, |
| 2550 | "description": "A human-readable alias for this connected account. Pass an empty string to clear the alias. Must be unique per entity and toolkit within the project." |
| 2551 | }, |
| 2552 | "connection": { |
| 2553 | "type": "object", |
| 2554 | "properties": { |
| 2555 | "state": { |
| 2556 | "type": "object", |
| 2557 | "properties": { |
| 2558 | "authScheme": { |
| 2559 | "type": "string", |
| 2560 | "enum": [ |
| 2561 | "BEARER_TOKEN", |
| 2562 | "API_KEY", |
| 2563 | "BASIC", |
| 2564 | "BASIC_WITH_JWT", |
| 2565 | "GOOGLE_SERVICE_ACCOUNT", |
| 2566 | "SERVICE_ACCOUNT" |
| 2567 | ], |
| 2568 | "description": "The auth scheme of the connected account. Must match the connection's actual auth scheme." |
| 2569 | }, |
| 2570 | "val": { |
| 2571 | "type": "object", |
| 2572 | "properties": { |
| 2573 | "token": { |
| 2574 | "type": "string", |
| 2575 | "nullable": true |
| 2576 | }, |
| 2577 | "generic_api_key": { |
| 2578 | "type": "string", |
| 2579 | "nullable": true |
| 2580 | }, |
| 2581 | "api_key": { |
| 2582 | "type": "string", |
| 2583 | "nullable": true |
| 2584 | }, |
| 2585 | "bearer_token": { |
| 2586 | "type": "string", |
| 2587 | "nullable": true |
| 2588 | }, |
| 2589 | "basic_encoded": { |
| 2590 | "type": "string", |
| 2591 | "nullable": true |
| 2592 | }, |
| 2593 | "generic_token": { |
| 2594 | "type": "string", |
| 2595 | "nullable": true |
| 2596 | }, |
| 2597 | "api_key_prefix": { |
| 2598 | "type": "string", |
| 2599 | "nullable": true |
| 2600 | }, |
| 2601 | "generic_secret": { |
| 2602 | "type": "string", |
| 2603 | "nullable": true |
| 2604 | }, |
| 2605 | "generic_id": { |
| 2606 | "type": "string", |
| 2607 | "nullable": true |
| 2608 | }, |
| 2609 | "user_agent": { |
| 2610 | "type": "string", |
| 2611 | "nullable": true |
| 2612 | }, |
| 2613 | "username": { |
| 2614 | "type": "string", |
| 2615 | "nullable": true |
| 2616 | }, |
| 2617 | "password": { |
| 2618 | "type": "string", |
| 2619 | "nullable": true |
| 2620 | }, |
| 2621 | "credentials_json": { |
| 2622 | "type": "string", |
| 2623 | "nullable": true |
| 2624 | }, |
| 2625 | "application_id": { |
| 2626 | "type": "string", |
| 2627 | "nullable": true |
| 2628 | }, |
| 2629 | "installation_id": { |
| 2630 | "type": "string", |
| 2631 | "nullable": true |
| 2632 | }, |
| 2633 | "private_key": { |
| 2634 | "type": "string", |
| 2635 | "nullable": true |
| 2636 | } |
| 2637 | }, |
| 2638 | "additionalProperties": false, |
| 2639 | "description": "Credential fields to update. Only provided fields are changed — omitted fields are preserved. Set a field to null to remove it." |
| 2640 | } |
| 2641 | }, |
| 2642 | "required": [ |
| 2643 | "authScheme", |
| 2644 | "val" |
| 2645 | ] |
| 2646 | } |
| 2647 | }, |
| 2648 | "required": [ |
| 2649 | "state" |
| 2650 | ] |
| 2651 | }, |
| 2652 | "experimental": { |
| 2653 | "type": "object", |
| 2654 | "properties": { |
| 2655 | "acl_config_for_shared": { |
| 2656 | "type": "object", |
| 2657 | "properties": { |
| 2658 | "allow_all_users": { |
| 2659 | "type": "boolean", |
| 2660 | "description": "Wildcard \"any user_id in the project\" allow toggle. Only valid on SHARED connections." |
| 2661 | }, |
| 2662 | "allowed_user_ids": { |
| 2663 | "type": "array", |
| 2664 | "items": { |
| 2665 | "type": "string", |
| 2666 | "minLength": 1, |
| 2667 | "maxLength": 256 |
| 2668 | }, |
| 2669 | "maxItems": 1000, |
| 2670 | "description": "Explicit allow list of user_ids who can use this SHARED connection." |
| 2671 | }, |
| 2672 | "not_allowed_user_ids": { |
| 2673 | "type": "array", |
| 2674 | "items": { |
| 2675 | "type": "string", |
| 2676 | "minLength": 1, |
| 2677 | "maxLength": 256 |
| 2678 | }, |
| 2679 | "maxItems": 1000, |
| 2680 | "description": "Explicit deny list. Wins on conflict with allow_all_users and allowed_user_ids." |
| 2681 | } |
| 2682 | }, |
| 2683 | "description": "Access control for SHARED connections. Resolution rule (only fires when caller != creator): user in not_allowed_user_ids → DENY; allow_all_users=true → ALLOW; user in allowed_user_ids → ALLOW; else DENY. Default state (omitted or {}) is deny-by-default — only the creator can use.", |
| 2684 | "x-experimental": true |
| 2685 | } |
| 2686 | }, |
| 2687 | "description": "Experimental features - not stable, may be modified or removed in future versions.", |
| 2688 | "x-experimental": true |
| 2689 | } |
| 2690 | } |
| 2691 | }, |
| 2692 | "DeprecatedToolkitInfo": { |
| 2693 | "type": "object", |
| 2694 | "properties": { |
| 2695 | "toolkitId": { |
| 2696 | "type": "string" |
| 2697 | } |
| 2698 | }, |
| 2699 | "required": [ |
| 2700 | "toolkitId" |
| 2701 | ], |
| 2702 | "description": "Deprecated toolkit ID", |
| 2703 | "deprecated": true, |
| 2704 | "example": { |
| 2705 | "toolkitId": "550e8400-e29b-41d4-a716-446655440000" |
| 2706 | } |
| 2707 | }, |
| 2708 | "ProxyExecuteCompleted": { |
| 2709 | "type": "object", |
| 2710 | "properties": { |
| 2711 | "result_type": { |
| 2712 | "type": "string", |
| 2713 | "enum": [ |
| 2714 | "completed" |
| 2715 | ], |
| 2716 | "description": "The request was sent and the proxied API responded", |
| 2717 | "x-experimental": true |
| 2718 | }, |
| 2719 | "data": { |
| 2720 | "nullable": true, |
| 2721 | "description": "The response data returned from the proxied API", |
| 2722 | "example": { |
| 2723 | "id": "123", |
| 2724 | "name": "Resource Name", |
| 2725 | "created_at": "2023-01-01T00:00:00Z" |
| 2726 | }, |
| 2727 | "type": "object" |
| 2728 | }, |
| 2729 | "binary_data": { |
| 2730 | "type": "object", |
| 2731 | "properties": { |
| 2732 | "url": { |
| 2733 | "type": "string", |
| 2734 | "description": "URL to download binary content" |
| 2735 | }, |
| 2736 | "content_type": { |
| 2737 | "type": "string", |
| 2738 | "description": "Content-Type of the binary data" |
| 2739 | }, |
| 2740 | "size": { |
| 2741 | "type": "number", |
| 2742 | "description": "File size in bytes" |
| 2743 | }, |
| 2744 | "expires_at": { |
| 2745 | "type": "string", |
| 2746 | "description": "ISO 8601 timestamp when the URL expires" |
| 2747 | } |
| 2748 | }, |
| 2749 | "required": [ |
| 2750 | "url", |
| 2751 | "content_type", |
| 2752 | "size" |
| 2753 | ], |
| 2754 | "description": "Binary body response data. Present when the response is a binary file." |
| 2755 | }, |
| 2756 | "status": { |
| 2757 | "type": "number", |
| 2758 | "description": "The HTTP status code returned from the proxied API", |
| 2759 | "example": 200 |
| 2760 | }, |
| 2761 | "headers": { |
| 2762 | "type": "object", |
| 2763 | "additionalProperties": { |
| 2764 | "type": "string" |
| 2765 | }, |
| 2766 | "description": "The HTTP headers returned from the proxied API", |
| 2767 | "example": { |
| 2768 | "content-type": "application/json", |
| 2769 | "cache-control": "no-cache" |
| 2770 | } |
| 2771 | }, |
| 2772 | "hook_results": { |
| 2773 | "type": "array", |
| 2774 | "items": { |
| 2775 | "$ref": "#/components/schemas/HookResult" |
| 2776 | }, |
| 2777 | "description": "Every session hook that applied to this request. Omitted when none applied." |
| 2778 | } |
| 2779 | }, |
| 2780 | "required": [ |
| 2781 | "result_type", |
| 2782 | "status" |
| 2783 | ] |
| 2784 | }, |
| 2785 | "ProxyExecuteBlocked": { |
| 2786 | "type": "object", |
| 2787 | "properties": { |
| 2788 | "result_type": { |
| 2789 | "type": "string", |
| 2790 | "enum": [ |
| 2791 | "blocked" |
| 2792 | ], |
| 2793 | "description": "A session hook stopped the call" |
| 2794 | }, |
| 2795 | "reason": { |
| 2796 | "$ref": "#/components/schemas/BlockReason" |
| 2797 | }, |
| 2798 | "message": { |
| 2799 | "type": "string", |
| 2800 | "description": "A message for the agent. It includes the hook's name, when it has one; the hook id is in `reason`.", |
| 2801 | "example": "Blocked by session policy: No external email" |
| 2802 | }, |
| 2803 | "hook_results": { |
| 2804 | "type": "array", |
| 2805 | "items": { |
| 2806 | "$ref": "#/components/schemas/HookResult" |
| 2807 | }, |
| 2808 | "description": "Every session hook that applied to this call. Omitted when none applied." |
| 2809 | } |
| 2810 | }, |
| 2811 | "required": [ |
| 2812 | "result_type", |
| 2813 | "reason", |
| 2814 | "message" |
| 2815 | ] |
| 2816 | }, |
| 2817 | "ToolRouterToolkitsListResponse": { |
| 2818 | "type": "object", |
| 2819 | "properties": { |
| 2820 | "items": { |
| 2821 | "type": "array", |
| 2822 | "items": { |
| 2823 | "type": "object", |
| 2824 | "properties": { |
| 2825 | "name": { |
| 2826 | "type": "string", |
| 2827 | "description": "Display name of the toolkit" |
| 2828 | }, |
| 2829 | "slug": { |
| 2830 | "type": "string", |
| 2831 | "description": "Unique slug identifier" |
| 2832 | }, |
| 2833 | "enabled": { |
| 2834 | "type": "boolean", |
| 2835 | "description": "Whether the toolkit is enabled" |
| 2836 | }, |
| 2837 | "is_no_auth": { |
| 2838 | "type": "boolean", |
| 2839 | "description": "Whether the toolkit is no-auth" |
| 2840 | }, |
| 2841 | "composio_managed_auth_schemes": { |
| 2842 | "type": "array", |
| 2843 | "items": { |
| 2844 | "type": "string" |
| 2845 | }, |
| 2846 | "description": "Available Composio-managed auth schemes" |
| 2847 | }, |
| 2848 | "meta": { |
| 2849 | "type": "object", |
| 2850 | "properties": { |
| 2851 | "logo": { |
| 2852 | "type": "string", |
| 2853 | "format": "uri", |
| 2854 | "description": "URL to the toolkit logo" |
| 2855 | }, |
| 2856 | "description": { |
| 2857 | "type": "string", |
| 2858 | "description": "Description of the toolkit" |
| 2859 | }, |
| 2860 | "isNoAuth": { |
| 2861 | "type": "boolean", |
| 2862 | "description": "Duplicates the top-level is_no_auth field. Kept for backward compatibility with existing readers; use is_no_auth instead.", |
| 2863 | "deprecated": true |
| 2864 | } |
| 2865 | }, |
| 2866 | "required": [ |
| 2867 | "logo", |
| 2868 | "description" |
| 2869 | ], |
| 2870 | "description": "Toolkit metadata" |
| 2871 | }, |
| 2872 | "connected_account": { |
| 2873 | "type": "object", |
| 2874 | "nullable": true, |
| 2875 | "properties": { |
| 2876 | "id": { |
| 2877 | "type": "string", |
| 2878 | "format": "connectedAccountId", |
| 2879 | "description": "Connected account identifier" |
| 2880 | }, |
| 2881 | "user_id": { |
| 2882 | "type": "string", |
| 2883 | "description": "User identifier" |
| 2884 | }, |
| 2885 | "status": { |
| 2886 | "type": "string", |
| 2887 | "description": "Connection status" |
| 2888 | }, |
| 2889 | "created_at": { |
| 2890 | "type": "string", |
| 2891 | "format": "date-time", |
| 2892 | "description": "Creation timestamp" |
| 2893 | }, |
| 2894 | "auth_config": { |
| 2895 | "type": "object", |
| 2896 | "properties": { |
| 2897 | "id": { |
| 2898 | "type": "string", |
| 2899 | "description": "Auth config identifier" |
| 2900 | }, |
| 2901 | "auth_scheme": { |
| 2902 | "type": "string", |
| 2903 | "description": "Authentication scheme type" |
| 2904 | }, |
| 2905 | "is_composio_managed": { |
| 2906 | "type": "boolean", |
| 2907 | "description": "Whether this is a Composio-managed auth config" |
| 2908 | } |
| 2909 | }, |
| 2910 | "required": [ |
| 2911 | "id", |
| 2912 | "auth_scheme", |
| 2913 | "is_composio_managed" |
| 2914 | ], |
| 2915 | "description": "Auth config details" |
| 2916 | } |
| 2917 | }, |
| 2918 | "required": [ |
| 2919 | "id", |
| 2920 | "user_id", |
| 2921 | "status", |
| 2922 | "created_at", |
| 2923 | "auth_config" |
| 2924 | ], |
| 2925 | "description": "Connected account if available" |
| 2926 | } |
| 2927 | }, |
| 2928 | "required": [ |
| 2929 | "name", |
| 2930 | "slug", |
| 2931 | "enabled", |
| 2932 | "is_no_auth", |
| 2933 | "composio_managed_auth_schemes", |
| 2934 | "meta", |
| 2935 | "connected_account" |
| 2936 | ] |
| 2937 | } |
| 2938 | }, |
| 2939 | "next_cursor": { |
| 2940 | "type": "string", |
| 2941 | "nullable": true |
| 2942 | }, |
| 2943 | "total_pages": { |
| 2944 | "type": "number" |
| 2945 | }, |
| 2946 | "current_page": { |
| 2947 | "type": "number" |
| 2948 | }, |
| 2949 | "total_items": { |
| 2950 | "type": "number" |
| 2951 | } |
| 2952 | }, |
| 2953 | "required": [ |
| 2954 | "items", |
| 2955 | "total_pages", |
| 2956 | "current_page", |
| 2957 | "total_items" |
| 2958 | ] |
| 2959 | } |
| 2960 | }, |
| 2961 | "parameters": {} |
| 2962 | }, |
| 2963 | "paths": { |
| 2964 | "/api/v3.1/session_configs": { |
| 2965 | "get": { |
| 2966 | "summary": "List Session configs", |
| 2967 | "description": "List Session configs in your project, newest updated first. Returns active configs by default; set archived=true to list archived configs, or include_archived=true for both. Set include_summary=true for each config's description and access summary. Retrieve a config by ID for its full toolkit, tool, and tag policy. Experimental. Create and manage configs in Dashboard.", |
| 2968 | "tags": [ |
| 2969 | "Tool Router" |
| 2970 | ], |
| 2971 | "operationId": "getSessionConfigs", |
| 2972 | "security": [ |
| 2973 | { |
| 2974 | "ApiKeyAuth": [] |
| 2975 | } |
| 2976 | ], |
| 2977 | "parameters": [ |
| 2978 | { |
| 2979 | "schema": { |
| 2980 | "type": "string", |
| 2981 | "description": "Opaque cursor from the previous page." |
| 2982 | }, |
| 2983 | "required": false, |
| 2984 | "description": "Opaque cursor from the previous page.", |
| 2985 | "name": "cursor", |
| 2986 | "in": "query" |
| 2987 | }, |
| 2988 | { |
| 2989 | "schema": { |
| 2990 | "type": "integer", |
| 2991 | "minimum": 0, |
| 2992 | "exclusiveMinimum": true, |
| 2993 | "maximum": 100, |
| 2994 | "default": 20, |
| 2995 | "description": "Maximum number of configs to return, from 1 to 100." |
| 2996 | }, |
| 2997 | "required": false, |
| 2998 | "description": "Maximum number of configs to return, from 1 to 100.", |
| 2999 | "name": "limit", |
| 3000 | "in": "query" |
| 3001 | }, |
| 3002 | { |
| 3003 | "schema": { |
| 3004 | "type": "boolean", |
| 3005 | "nullable": true, |
| 3006 | "default": false, |
| 3007 | "description": "Return archived configs when true. Defaults to active configs only." |
| 3008 | }, |
| 3009 | "required": false, |
| 3010 | "description": "Return archived configs when true. Defaults to active configs only.", |
| 3011 | "name": "archived", |
| 3012 | "in": "query" |
| 3013 | }, |
| 3014 | { |
| 3015 | "schema": { |
| 3016 | "type": "boolean", |
| 3017 | "nullable": true, |
| 3018 | "default": false, |
| 3019 | "description": "List active and archived configs together when true. Cannot be combined with archived=true." |
| 3020 | }, |
| 3021 | "required": false, |
| 3022 | "description": "List active and archived configs together when true. Cannot be combined with archived=true.", |
| 3023 | "name": "include_archived", |
| 3024 | "in": "query" |
| 3025 | }, |
| 3026 | { |
| 3027 | "schema": { |
| 3028 | "type": "boolean", |
| 3029 | "nullable": true, |
| 3030 | "default": false, |
| 3031 | "description": "Add each config's description and access summary when true." |
| 3032 | }, |
| 3033 | "required": false, |
| 3034 | "description": "Add each config's description and access summary when true.", |
| 3035 | "name": "include_summary", |
| 3036 | "in": "query" |
| 3037 | } |
| 3038 | ], |
| 3039 | "responses": { |
| 3040 | "200": { |
| 3041 | "description": "Session configs listed.", |
| 3042 | "content": { |
| 3043 | "application/json": { |
| 3044 | "schema": { |
| 3045 | "type": "object", |
| 3046 | "properties": { |
| 3047 | "items": { |
| 3048 | "type": "array", |
| 3049 | "items": { |
| 3050 | "type": "object", |
| 3051 | "properties": { |
| 3052 | "id": { |
| 3053 | "type": "string", |
| 3054 | "format": "sessionConfigId", |
| 3055 | "description": "Stable public identifier of the Session config." |
| 3056 | }, |
| 3057 | "name": { |
| 3058 | "type": "string", |
| 3059 | "description": "Project-unique display name." |
| 3060 | }, |
| 3061 | "archived": { |
| 3062 | "type": "boolean", |
| 3063 | "description": "Whether the config is archived." |
| 3064 | }, |
| 3065 | "created_at": { |
| 3066 | "type": "string", |
| 3067 | "format": "date-time", |
| 3068 | "description": "Creation time in ISO 8601." |
| 3069 | }, |
| 3070 | "updated_at": { |
| 3071 | "type": "string", |
| 3072 | "format": "date-time", |
| 3073 | "description": "Last update time in ISO 8601." |
| 3074 | }, |
| 3075 | "description": { |
| 3076 | "type": "string", |
| 3077 | "nullable": true, |
| 3078 | "description": "Optional description of when the config should be used." |
| 3079 | }, |
| 3080 | "toolkit_scope": { |
| 3081 | "type": "object", |
| 3082 | "properties": { |
| 3083 | "mode": { |
| 3084 | "type": "string", |
| 3085 | "enum": [ |
| 3086 | "all", |
| 3087 | "selected", |
| 3088 | "all_except" |
| 3089 | ], |
| 3090 | "description": "How the toolkit list defines the effective scope." |
| 3091 | }, |
| 3092 | "toolkits": { |
| 3093 | "type": "array", |
| 3094 | "items": { |
| 3095 | "type": "string" |
| 3096 | }, |
| 3097 | "description": "Selected or excluded toolkit slugs for this scope." |
| 3098 | } |
| 3099 | }, |
| 3100 | "required": [ |
| 3101 | "mode", |
| 3102 | "toolkits" |
| 3103 | ], |
| 3104 | "description": "Compact toolkit scope for list rendering." |
| 3105 | }, |
| 3106 | "default_access": { |
| 3107 | "type": "string", |
| 3108 | "enum": [ |
| 3109 | "full", |
| 3110 | "read_only", |
| 3111 | "non_destructive", |
| 3112 | "custom" |
| 3113 | ], |
| 3114 | "description": "Default access level applied across the toolkit scope." |
| 3115 | }, |
| 3116 | "exception_count": { |
| 3117 | "type": "integer", |
| 3118 | "minimum": 0, |
| 3119 | "description": "Number of toolkit-specific access overrides." |
| 3120 | } |
| 3121 | }, |
| 3122 | "required": [ |
| 3123 | "id", |
| 3124 | "name", |
| 3125 | "archived", |
| 3126 | "created_at", |
| 3127 | "updated_at" |
| 3128 | ] |
| 3129 | }, |
| 3130 | "description": "Configs, newest updated first. Set include_summary=true for descriptions and access summaries, or retrieve a config by ID for its full access policy." |
| 3131 | }, |
| 3132 | "next_cursor": { |
| 3133 | "type": "string", |
| 3134 | "nullable": true, |
| 3135 | "description": "Opaque cursor for the next page, or null when there are no more results." |
| 3136 | } |
| 3137 | }, |
| 3138 | "required": [ |
| 3139 | "items", |
| 3140 | "next_cursor" |
| 3141 | ], |
| 3142 | "x-experimental": true |
| 3143 | } |
| 3144 | } |
| 3145 | } |
| 3146 | }, |
| 3147 | "400": { |
| 3148 | "description": "Invalid filter or pagination cursor.", |
| 3149 | "content": { |
| 3150 | "application/json": { |
| 3151 | "schema": { |
| 3152 | "$ref": "#/components/schemas/Error" |
| 3153 | } |
| 3154 | } |
| 3155 | } |
| 3156 | }, |
| 3157 | "401": { |
| 3158 | "description": "Unauthorized.", |
| 3159 | "content": { |
| 3160 | "application/json": { |
| 3161 | "schema": { |
| 3162 | "$ref": "#/components/schemas/Error" |
| 3163 | } |
| 3164 | } |
| 3165 | } |
| 3166 | }, |
| 3167 | "403": { |
| 3168 | "description": "Forbidden. The API key lacks Session management read access.", |
| 3169 | "content": { |
| 3170 | "application/json": { |
| 3171 | "schema": { |
| 3172 | "$ref": "#/components/schemas/Error" |
| 3173 | } |
| 3174 | } |
| 3175 | } |
| 3176 | }, |
| 3177 | "404": { |
| 3178 | "description": "Project not found.", |
| 3179 | "content": { |
| 3180 | "application/json": { |
| 3181 | "schema": { |
| 3182 | "$ref": "#/components/schemas/Error" |
| 3183 | } |
| 3184 | } |
| 3185 | } |
| 3186 | }, |
| 3187 | "500": { |
| 3188 | "description": "Internal server error.", |
| 3189 | "content": { |
| 3190 | "application/json": { |
| 3191 | "schema": { |
| 3192 | "$ref": "#/components/schemas/Error" |
| 3193 | } |
| 3194 | } |
| 3195 | } |
| 3196 | } |
| 3197 | }, |
| 3198 | "x-api-version": "3.1" |
| 3199 | } |
| 3200 | }, |
| 3201 | "/api/v3.1/session_configs/{session_config_id}": { |
| 3202 | "get": { |
| 3203 | "summary": "Retrieve a Session config", |
| 3204 | "description": "Retrieve a saved access policy in your project. config.toolkits.enable selects toolkit slugs; config.toolkits.disable excludes them; an omitted config.toolkits allows all toolkits. Tool and tag rules further restrict access. This returns the saved policy, not an expanded catalog or an existing Session snapshot. Archived configs remain readable but cannot create new Sessions. Experimental. Create and manage configs in Dashboard.", |
| 3205 | "tags": [ |
| 3206 | "Tool Router" |
| 3207 | ], |
| 3208 | "operationId": "getSessionConfigsBySessionConfigId", |
| 3209 | "security": [ |
| 3210 | { |
| 3211 | "ApiKeyAuth": [] |
| 3212 | } |
| 3213 | ], |
| 3214 | "parameters": [ |
| 3215 | { |
| 3216 | "schema": { |
| 3217 | "type": "string", |
| 3218 | "format": "sessionConfigId", |
| 3219 | "description": "The Session config ID returned by the list endpoint or Dashboard.", |
| 3220 | "example": "sc_123456789012" |
| 3221 | }, |
| 3222 | "required": true, |
| 3223 | "name": "session_config_id", |
| 3224 | "in": "path" |
| 3225 | } |
| 3226 | ], |
| 3227 | "responses": { |
| 3228 | "200": { |
| 3229 | "description": "Session config retrieved.", |
| 3230 | "content": { |
| 3231 | "application/json": { |
| 3232 | "schema": { |
| 3233 | "type": "object", |
| 3234 | "properties": { |
| 3235 | "id": { |
| 3236 | "type": "string", |
| 3237 | "format": "sessionConfigId", |
| 3238 | "description": "Stable public identifier of the Session config." |
| 3239 | }, |
| 3240 | "name": { |
| 3241 | "type": "string", |
| 3242 | "description": "Project-unique display name." |
| 3243 | }, |
| 3244 | "description": { |
| 3245 | "type": "string", |
| 3246 | "nullable": true, |
| 3247 | "description": "Optional description of when the config should be used." |
| 3248 | }, |
| 3249 | "archived": { |
| 3250 | "type": "boolean", |
| 3251 | "description": "Whether the config is archived." |
| 3252 | }, |
| 3253 | "config": { |
| 3254 | "type": "object", |
| 3255 | "properties": { |
| 3256 | "toolkits": { |
| 3257 | "anyOf": [ |
| 3258 | { |
| 3259 | "type": "object", |
| 3260 | "properties": { |
| 3261 | "enable": { |
| 3262 | "type": "array", |
| 3263 | "items": { |
| 3264 | "type": "string" |
| 3265 | } |
| 3266 | }, |
| 3267 | "require_approval": { |
| 3268 | "type": "array", |
| 3269 | "items": { |
| 3270 | "type": "string" |
| 3271 | }, |
| 3272 | "description": "What in this entry needs the user's approval before it runs." |
| 3273 | } |
| 3274 | }, |
| 3275 | "required": [ |
| 3276 | "enable" |
| 3277 | ], |
| 3278 | "additionalProperties": false |
| 3279 | }, |
| 3280 | { |
| 3281 | "type": "object", |
| 3282 | "properties": { |
| 3283 | "disable": { |
| 3284 | "type": "array", |
| 3285 | "items": { |
| 3286 | "type": "string" |
| 3287 | } |
| 3288 | }, |
| 3289 | "require_approval": { |
| 3290 | "type": "array", |
| 3291 | "items": { |
| 3292 | "type": "string" |
| 3293 | }, |
| 3294 | "description": "What in this entry needs the user's approval before it runs." |
| 3295 | } |
| 3296 | }, |
| 3297 | "required": [ |
| 3298 | "disable" |
| 3299 | ], |
| 3300 | "additionalProperties": false |
| 3301 | }, |
| 3302 | { |
| 3303 | "type": "object", |
| 3304 | "properties": { |
| 3305 | "require_approval": { |
| 3306 | "type": "array", |
| 3307 | "items": { |
| 3308 | "type": "string" |
| 3309 | }, |
| 3310 | "description": "What in this entry needs the user's approval before it runs." |
| 3311 | } |
| 3312 | }, |
| 3313 | "required": [ |
| 3314 | "require_approval" |
| 3315 | ], |
| 3316 | "additionalProperties": false |
| 3317 | } |
| 3318 | ] |
| 3319 | }, |
| 3320 | "tools": { |
| 3321 | "type": "object", |
| 3322 | "additionalProperties": { |
| 3323 | "anyOf": [ |
| 3324 | { |
| 3325 | "type": "object", |
| 3326 | "properties": { |
| 3327 | "enable": { |
| 3328 | "type": "array", |
| 3329 | "items": { |
| 3330 | "type": "string" |
| 3331 | } |
| 3332 | }, |
| 3333 | "require_approval": { |
| 3334 | "type": "array", |
| 3335 | "items": { |
| 3336 | "type": "string" |
| 3337 | }, |
| 3338 | "description": "What in this entry needs the user's approval before it runs." |
| 3339 | } |
| 3340 | }, |
| 3341 | "required": [ |
| 3342 | "enable" |
| 3343 | ], |
| 3344 | "additionalProperties": false |
| 3345 | }, |
| 3346 | { |
| 3347 | "type": "object", |
| 3348 | "properties": { |
| 3349 | "disable": { |
| 3350 | "type": "array", |
| 3351 | "items": { |
| 3352 | "type": "string" |
| 3353 | } |
| 3354 | }, |
| 3355 | "require_approval": { |
| 3356 | "type": "array", |
| 3357 | "items": { |
| 3358 | "type": "string" |
| 3359 | }, |
| 3360 | "description": "What in this entry needs the user's approval before it runs." |
| 3361 | } |
| 3362 | }, |
| 3363 | "required": [ |
| 3364 | "disable" |
| 3365 | ], |
| 3366 | "additionalProperties": false |
| 3367 | }, |
| 3368 | { |
| 3369 | "type": "object", |
| 3370 | "properties": { |
| 3371 | "tags": { |
| 3372 | "type": "object", |
| 3373 | "properties": { |
| 3374 | "enable": { |
| 3375 | "type": "array", |
| 3376 | "items": { |
| 3377 | "type": "string", |
| 3378 | "enum": [ |
| 3379 | "readOnlyHint", |
| 3380 | "createHint", |
| 3381 | "updateHint", |
| 3382 | "destructiveHint", |
| 3383 | "idempotentHint", |
| 3384 | "openWorldHint" |
| 3385 | ] |
| 3386 | } |
| 3387 | }, |
| 3388 | "disable": { |
| 3389 | "type": "array", |
| 3390 | "items": { |
| 3391 | "type": "string", |
| 3392 | "enum": [ |
| 3393 | "readOnlyHint", |
| 3394 | "createHint", |
| 3395 | "updateHint", |
| 3396 | "destructiveHint", |
| 3397 | "idempotentHint", |
| 3398 | "openWorldHint" |
| 3399 | ] |
| 3400 | } |
| 3401 | }, |
| 3402 | "require_approval": { |
| 3403 | "type": "array", |
| 3404 | "items": { |
| 3405 | "type": "string", |
| 3406 | "enum": [ |
| 3407 | "readOnlyHint", |
| 3408 | "createHint", |
| 3409 | "updateHint", |
| 3410 | "destructiveHint", |
| 3411 | "idempotentHint", |
| 3412 | "openWorldHint" |
| 3413 | ] |
| 3414 | }, |
| 3415 | "description": "Tags whose tools need the user's approval before they run." |
| 3416 | } |
| 3417 | }, |
| 3418 | "additionalProperties": false |
| 3419 | }, |
| 3420 | "require_approval": { |
| 3421 | "type": "array", |
| 3422 | "items": { |
| 3423 | "type": "string" |
| 3424 | }, |
| 3425 | "description": "What in this entry needs the user's approval before it runs." |
| 3426 | } |
| 3427 | }, |
| 3428 | "required": [ |
| 3429 | "tags" |
| 3430 | ], |
| 3431 | "additionalProperties": false |
| 3432 | }, |
| 3433 | { |
| 3434 | "type": "object", |
| 3435 | "properties": { |
| 3436 | "require_approval": { |
| 3437 | "type": "array", |
| 3438 | "items": { |
| 3439 | "type": "string" |
| 3440 | }, |
| 3441 | "description": "What in this entry needs the user's approval before it runs." |
| 3442 | } |
| 3443 | }, |
| 3444 | "required": [ |
| 3445 | "require_approval" |
| 3446 | ], |
| 3447 | "additionalProperties": false |
| 3448 | } |
| 3449 | ] |
| 3450 | } |
| 3451 | }, |
| 3452 | "tags": { |
| 3453 | "type": "object", |
| 3454 | "properties": { |
| 3455 | "enable": { |
| 3456 | "type": "array", |
| 3457 | "items": { |
| 3458 | "type": "string", |
| 3459 | "enum": [ |
| 3460 | "readOnlyHint", |
| 3461 | "createHint", |
| 3462 | "updateHint", |
| 3463 | "destructiveHint", |
| 3464 | "idempotentHint", |
| 3465 | "openWorldHint" |
| 3466 | ] |
| 3467 | } |
| 3468 | }, |
| 3469 | "disable": { |
| 3470 | "type": "array", |
| 3471 | "items": { |
| 3472 | "type": "string", |
| 3473 | "enum": [ |
| 3474 | "readOnlyHint", |
| 3475 | "createHint", |
| 3476 | "updateHint", |
| 3477 | "destructiveHint", |
| 3478 | "idempotentHint", |
| 3479 | "openWorldHint" |
| 3480 | ] |
| 3481 | } |
| 3482 | }, |
| 3483 | "require_approval": { |
| 3484 | "type": "array", |
| 3485 | "items": { |
| 3486 | "type": "string", |
| 3487 | "enum": [ |
| 3488 | "readOnlyHint", |
| 3489 | "createHint", |
| 3490 | "updateHint", |
| 3491 | "destructiveHint", |
| 3492 | "idempotentHint", |
| 3493 | "openWorldHint" |
| 3494 | ] |
| 3495 | }, |
| 3496 | "description": "Tags whose tools need the user's approval before they run." |
| 3497 | } |
| 3498 | }, |
| 3499 | "additionalProperties": false |
| 3500 | } |
| 3501 | }, |
| 3502 | "additionalProperties": false, |
| 3503 | "description": "Stored Session access policy using the same enable/disable wire shape accepted on create and update, with any require_approval lists." |
| 3504 | }, |
| 3505 | "created_at": { |
| 3506 | "type": "string", |
| 3507 | "format": "date-time", |
| 3508 | "description": "Creation time in ISO 8601." |
| 3509 | }, |
| 3510 | "updated_at": { |
| 3511 | "type": "string", |
| 3512 | "format": "date-time", |
| 3513 | "description": "Last update time in ISO 8601." |
| 3514 | } |
| 3515 | }, |
| 3516 | "required": [ |
| 3517 | "id", |
| 3518 | "name", |
| 3519 | "description", |
| 3520 | "archived", |
| 3521 | "config", |
| 3522 | "created_at", |
| 3523 | "updated_at" |
| 3524 | ], |
| 3525 | "x-experimental": true |
| 3526 | } |
| 3527 | } |
| 3528 | } |
| 3529 | }, |
| 3530 | "400": { |
| 3531 | "description": "Invalid Session config ID.", |
| 3532 | "content": { |
| 3533 | "application/json": { |
| 3534 | "schema": { |
| 3535 | "$ref": "#/components/schemas/Error" |
| 3536 | } |
| 3537 | } |
| 3538 | } |
| 3539 | }, |
| 3540 | "401": { |
| 3541 | "description": "Unauthorized.", |
| 3542 | "content": { |
| 3543 | "application/json": { |
| 3544 | "schema": { |
| 3545 | "$ref": "#/components/schemas/Error" |
| 3546 | } |
| 3547 | } |
| 3548 | } |
| 3549 | }, |
| 3550 | "403": { |
| 3551 | "description": "Forbidden. The API key lacks Session management read access.", |
| 3552 | "content": { |
| 3553 | "application/json": { |
| 3554 | "schema": { |
| 3555 | "$ref": "#/components/schemas/Error" |
| 3556 | } |
| 3557 | } |
| 3558 | } |
| 3559 | }, |
| 3560 | "404": { |
| 3561 | "description": "Session config not found in this project.", |
| 3562 | "content": { |
| 3563 | "application/json": { |
| 3564 | "schema": { |
| 3565 | "$ref": "#/components/schemas/Error" |
| 3566 | } |
| 3567 | } |
| 3568 | } |
| 3569 | }, |
| 3570 | "500": { |
| 3571 | "description": "Internal server error.", |
| 3572 | "content": { |
| 3573 | "application/json": { |
| 3574 | "schema": { |
| 3575 | "$ref": "#/components/schemas/Error" |
| 3576 | } |
| 3577 | } |
| 3578 | } |
| 3579 | } |
| 3580 | }, |
| 3581 | "x-api-version": "3.1" |
| 3582 | } |
| 3583 | }, |
| 3584 | "/api/v3.1/keyring/transfer_keys": { |
| 3585 | "get": { |
| 3586 | "summary": "Get the organization's active keyring transfer keys", |
| 3587 | "description": "Returns the public encryption keys from the authenticated project API key's organization keyring instance. The organization must have an ACTIVE customer keyring instance.", |
| 3588 | "tags": [ |
| 3589 | "Authentication" |
| 3590 | ], |
| 3591 | "operationId": "getKeyringTransferKeys", |
| 3592 | "security": [ |
| 3593 | { |
| 3594 | "ApiKeyAuth": [] |
| 3595 | } |
| 3596 | ], |
| 3597 | "responses": { |
| 3598 | "200": { |
| 3599 | "description": "Active keyring transfer keys.", |
| 3600 | "content": { |
| 3601 | "application/json": { |
| 3602 | "schema": { |
| 3603 | "type": "object", |
| 3604 | "properties": { |
| 3605 | "success": { |
| 3606 | "type": "boolean", |
| 3607 | "enum": [ |
| 3608 | true |
| 3609 | ] |
| 3610 | }, |
| 3611 | "active_kid": { |
| 3612 | "type": "string", |
| 3613 | "minLength": 1, |
| 3614 | "description": "The `kid` of the key to seal new secrets to. Older keys stay in `keys` so previously sealed values remain openable, so always seal to this one." |
| 3615 | }, |
| 3616 | "keys": { |
| 3617 | "type": "array", |
| 3618 | "items": { |
| 3619 | "type": "object", |
| 3620 | "properties": { |
| 3621 | "kty": { |
| 3622 | "type": "string", |
| 3623 | "enum": [ |
| 3624 | "RSA" |
| 3625 | ], |
| 3626 | "description": "Key type. Always `RSA`." |
| 3627 | }, |
| 3628 | "n": { |
| 3629 | "type": "string", |
| 3630 | "minLength": 1, |
| 3631 | "description": "RSA modulus, base64url-encoded." |
| 3632 | }, |
| 3633 | "e": { |
| 3634 | "type": "string", |
| 3635 | "minLength": 1, |
| 3636 | "description": "RSA public exponent, base64url-encoded." |
| 3637 | }, |
| 3638 | "alg": { |
| 3639 | "type": "string", |
| 3640 | "enum": [ |
| 3641 | "RSA-OAEP-256" |
| 3642 | ], |
| 3643 | "description": "Key-management algorithm for the JWE. Pair it with the `A256GCM` content algorithm." |
| 3644 | }, |
| 3645 | "use": { |
| 3646 | "type": "string", |
| 3647 | "enum": [ |
| 3648 | "enc" |
| 3649 | ], |
| 3650 | "description": "Key use. Always `enc`." |
| 3651 | }, |
| 3652 | "kid": { |
| 3653 | "type": "string", |
| 3654 | "minLength": 1, |
| 3655 | "description": "Key identifier. Put it in the JWE protected header so keyring can select the unwrapping key." |
| 3656 | } |
| 3657 | }, |
| 3658 | "required": [ |
| 3659 | "kty", |
| 3660 | "n", |
| 3661 | "e", |
| 3662 | "alg", |
| 3663 | "use", |
| 3664 | "kid" |
| 3665 | ], |
| 3666 | "description": "A public JWK a secret can be sealed to." |
| 3667 | }, |
| 3668 | "description": "Every currently accepted transfer key, newest first. Seal to `active_kid`." |
| 3669 | } |
| 3670 | }, |
| 3671 | "required": [ |
| 3672 | "success", |
| 3673 | "active_kid", |
| 3674 | "keys" |
| 3675 | ] |
| 3676 | } |
| 3677 | } |
| 3678 | } |
| 3679 | }, |
| 3680 | "400": { |
| 3681 | "description": "The active keyring instance configuration is invalid.", |
| 3682 | "content": { |
| 3683 | "application/json": { |
| 3684 | "schema": { |
| 3685 | "$ref": "#/components/schemas/Error" |
| 3686 | } |
| 3687 | } |
| 3688 | } |
| 3689 | }, |
| 3690 | "401": { |
| 3691 | "description": "Unauthorized.", |
| 3692 | "content": { |
| 3693 | "application/json": { |
| 3694 | "schema": { |
| 3695 | "$ref": "#/components/schemas/Error" |
| 3696 | } |
| 3697 | } |
| 3698 | } |
| 3699 | }, |
| 3700 | "404": { |
| 3701 | "description": "The API key organization has no ACTIVE keyring instance.", |
| 3702 | "content": { |
| 3703 | "application/json": { |
| 3704 | "schema": { |
| 3705 | "$ref": "#/components/schemas/Error" |
| 3706 | } |
| 3707 | } |
| 3708 | } |
| 3709 | }, |
| 3710 | "422": { |
| 3711 | "description": "The customer keyring instance is unavailable.", |
| 3712 | "content": { |
| 3713 | "application/json": { |
| 3714 | "schema": { |
| 3715 | "$ref": "#/components/schemas/Error" |
| 3716 | } |
| 3717 | } |
| 3718 | } |
| 3719 | }, |
| 3720 | "500": { |
| 3721 | "description": "Internal failure.", |
| 3722 | "content": { |
| 3723 | "application/json": { |
| 3724 | "schema": { |
| 3725 | "$ref": "#/components/schemas/Error" |
| 3726 | } |
| 3727 | } |
| 3728 | } |
| 3729 | }, |
| 3730 | "502": { |
| 3731 | "description": "The keyring instance returned an invalid response.", |
| 3732 | "content": { |
| 3733 | "application/json": { |
| 3734 | "schema": { |
| 3735 | "$ref": "#/components/schemas/Error" |
| 3736 | } |
| 3737 | } |
| 3738 | } |
| 3739 | } |
| 3740 | }, |
| 3741 | "x-api-version": "3.1" |
| 3742 | } |
| 3743 | }, |
| 3744 | "/api/v3.1/api_key_revocation": { |
| 3745 | "post": { |
| 3746 | "summary": "Revoke Composio API keys", |
| 3747 | "description": "Public endpoint for reporting and revoking Composio API keys that have been leaked (e.g. via the GitHub Secret Scanning Partner Program, third-party scanners, or self-reported leaks). Accepts project (ak_*), user (uak_*), and org (oak_*) keys in a single batch. Matched keys are revoked and stop working immediately. The response shape is constant regardless of whether any submitted key matched, so callers cannot use this endpoint to probe key existence. If a key cannot be revoked, the endpoint returns 500 and the request should be retried. The endpoint is rate limited; requests over the limit receive a 429.", |
| 3748 | "tags": [ |
| 3749 | "API Keys" |
| 3750 | ], |
| 3751 | "operationId": "postApiKeyRevocation", |
| 3752 | "security": [ |
| 3753 | { |
| 3754 | "no_auth": [] |
| 3755 | } |
| 3756 | ], |
| 3757 | "requestBody": { |
| 3758 | "required": true, |
| 3759 | "content": { |
| 3760 | "application/json": { |
| 3761 | "schema": { |
| 3762 | "type": "object", |
| 3763 | "properties": { |
| 3764 | "api_keys": { |
| 3765 | "type": "array", |
| 3766 | "items": { |
| 3767 | "type": "string", |
| 3768 | "minLength": 4, |
| 3769 | "maxLength": 256 |
| 3770 | }, |
| 3771 | "minItems": 1, |
| 3772 | "maxItems": 100, |
| 3773 | "description": "Composio API keys to revoke. Accepts project (ak_*), user (uak_*), and org (oak_*) keys. Each batch is capped at 100 entries." |
| 3774 | } |
| 3775 | }, |
| 3776 | "required": [ |
| 3777 | "api_keys" |
| 3778 | ] |
| 3779 | } |
| 3780 | } |
| 3781 | } |
| 3782 | }, |
| 3783 | "responses": { |
| 3784 | "200": { |
| 3785 | "description": "Revocation request received", |
| 3786 | "content": { |
| 3787 | "application/json": { |
| 3788 | "schema": { |
| 3789 | "type": "object", |
| 3790 | "properties": { |
| 3791 | "received": { |
| 3792 | "type": "boolean", |
| 3793 | "description": "Always true when the request body is valid. The response intentionally does not reveal whether any submitted key matched a record." |
| 3794 | } |
| 3795 | }, |
| 3796 | "required": [ |
| 3797 | "received" |
| 3798 | ] |
| 3799 | } |
| 3800 | } |
| 3801 | } |
| 3802 | }, |
| 3803 | "400": { |
| 3804 | "description": "Malformed payload", |
| 3805 | "content": { |
| 3806 | "application/json": { |
| 3807 | "schema": { |
| 3808 | "$ref": "#/components/schemas/Error" |
| 3809 | } |
| 3810 | } |
| 3811 | } |
| 3812 | }, |
| 3813 | "429": { |
| 3814 | "description": "Too many requests", |
| 3815 | "content": { |
| 3816 | "application/json": { |
| 3817 | "schema": { |
| 3818 | "$ref": "#/components/schemas/Error" |
| 3819 | } |
| 3820 | } |
| 3821 | } |
| 3822 | }, |
| 3823 | "500": { |
| 3824 | "description": "A key could not be revoked. Retry the request.", |
| 3825 | "content": { |
| 3826 | "application/json": { |
| 3827 | "schema": { |
| 3828 | "$ref": "#/components/schemas/Error" |
| 3829 | } |
| 3830 | } |
| 3831 | } |
| 3832 | } |
| 3833 | }, |
| 3834 | "x-api-version": "3.1" |
| 3835 | } |
| 3836 | }, |
| 3837 | "/api/v3.1/logs/tool_execution": { |
| 3838 | "post": { |
| 3839 | "summary": "Search and retrieve tool execution logs", |
| 3840 | "description": "Search and retrieve tool execution logs with filtering, pagination, and time range support.", |
| 3841 | "tags": [ |
| 3842 | "Logs" |
| 3843 | ], |
| 3844 | "operationId": "postLogsToolExecution", |
| 3845 | "security": [ |
| 3846 | { |
| 3847 | "ApiKeyAuth": [] |
| 3848 | } |
| 3849 | ], |
| 3850 | "requestBody": { |
| 3851 | "content": { |
| 3852 | "application/json": { |
| 3853 | "schema": { |
| 3854 | "type": "object", |
| 3855 | "properties": { |
| 3856 | "limit": { |
| 3857 | "type": "number", |
| 3858 | "minimum": 1, |
| 3859 | "maximum": 100, |
| 3860 | "default": 20 |
| 3861 | }, |
| 3862 | "cursor": { |
| 3863 | "type": "string", |
| 3864 | "nullable": true, |
| 3865 | "description": "The `next_cursor` from the previous page. Omit it for the first page." |
| 3866 | }, |
| 3867 | "filters": { |
| 3868 | "type": "array", |
| 3869 | "items": { |
| 3870 | "type": "object", |
| 3871 | "properties": { |
| 3872 | "field": { |
| 3873 | "type": "string", |
| 3874 | "enum": [ |
| 3875 | "tool_slug", |
| 3876 | "toolkit_slug", |
| 3877 | "connected_account_id", |
| 3878 | "auth_config_id", |
| 3879 | "status", |
| 3880 | "user_id", |
| 3881 | "session_id", |
| 3882 | "sandbox_id", |
| 3883 | "request_id", |
| 3884 | "log_id" |
| 3885 | ] |
| 3886 | }, |
| 3887 | "operator": { |
| 3888 | "type": "string", |
| 3889 | "enum": [ |
| 3890 | "==", |
| 3891 | "!=", |
| 3892 | "contains", |
| 3893 | "not_contains" |
| 3894 | ] |
| 3895 | }, |
| 3896 | "value": { |
| 3897 | "type": "string" |
| 3898 | } |
| 3899 | }, |
| 3900 | "required": [ |
| 3901 | "field", |
| 3902 | "operator", |
| 3903 | "value" |
| 3904 | ] |
| 3905 | }, |
| 3906 | "default": [] |
| 3907 | }, |
| 3908 | "time_range": { |
| 3909 | "type": "object", |
| 3910 | "properties": { |
| 3911 | "from": { |
| 3912 | "type": "number", |
| 3913 | "description": "Start time in epoch milliseconds" |
| 3914 | }, |
| 3915 | "to": { |
| 3916 | "type": "number", |
| 3917 | "description": "End time in epoch milliseconds" |
| 3918 | } |
| 3919 | }, |
| 3920 | "required": [ |
| 3921 | "from", |
| 3922 | "to" |
| 3923 | ] |
| 3924 | } |
| 3925 | } |
| 3926 | } |
| 3927 | } |
| 3928 | } |
| 3929 | }, |
| 3930 | "responses": { |
| 3931 | "200": { |
| 3932 | "description": "Successfully retrieved tool logs", |
| 3933 | "content": { |
| 3934 | "application/json": { |
| 3935 | "schema": { |
| 3936 | "type": "object", |
| 3937 | "properties": { |
| 3938 | "logs": { |
| 3939 | "type": "array", |
| 3940 | "items": { |
| 3941 | "type": "object", |
| 3942 | "properties": { |
| 3943 | "id": { |
| 3944 | "type": "string" |
| 3945 | }, |
| 3946 | "timestamp": { |
| 3947 | "type": "string", |
| 3948 | "format": "date-time", |
| 3949 | "description": "ISO 8601 timestamp" |
| 3950 | }, |
| 3951 | "type": { |
| 3952 | "type": "string", |
| 3953 | "description": "Log event type, e.g. tool.execution, trigger.message, connected_account.activated" |
| 3954 | }, |
| 3955 | "status": { |
| 3956 | "type": "string", |
| 3957 | "enum": [ |
| 3958 | "success", |
| 3959 | "failed" |
| 3960 | ] |
| 3961 | }, |
| 3962 | "level": { |
| 3963 | "type": "string", |
| 3964 | "enum": [ |
| 3965 | "info", |
| 3966 | "error", |
| 3967 | "warn" |
| 3968 | ] |
| 3969 | }, |
| 3970 | "message": { |
| 3971 | "type": "string" |
| 3972 | }, |
| 3973 | "metadata": { |
| 3974 | "type": "object", |
| 3975 | "properties": { |
| 3976 | "credential_source": { |
| 3977 | "type": "string", |
| 3978 | "enum": [ |
| 3979 | "connected_account", |
| 3980 | "instant_account", |
| 3981 | "custom_auth", |
| 3982 | "no_auth" |
| 3983 | ], |
| 3984 | "description": "Credential used for this execution. instant_account means a Composio Instant account. Omitted when no credential source was recorded." |
| 3985 | }, |
| 3986 | "instant_charge": { |
| 3987 | "type": "string", |
| 3988 | "description": "Instant charge in USD for this tool, as an exact decimal string. Omitted when no charge was recorded; zero is returned as the string 0." |
| 3989 | } |
| 3990 | }, |
| 3991 | "additionalProperties": {} |
| 3992 | }, |
| 3993 | "metrics": { |
| 3994 | "type": "object", |
| 3995 | "additionalProperties": {} |
| 3996 | }, |
| 3997 | "parent": { |
| 3998 | "type": "object", |
| 3999 | "nullable": true, |
| 4000 | "properties": { |
| 4001 | "log_id": { |
| 4002 | "type": "string" |
| 4003 | }, |
| 4004 | "tool_slug": { |
| 4005 | "type": "string" |
| 4006 | } |
| 4007 | }, |
| 4008 | "required": [ |
| 4009 | "log_id", |
| 4010 | "tool_slug" |
| 4011 | ] |
| 4012 | } |
| 4013 | }, |
| 4014 | "required": [ |
| 4015 | "id", |
| 4016 | "timestamp", |
| 4017 | "type", |
| 4018 | "status", |
| 4019 | "level", |
| 4020 | "metadata", |
| 4021 | "metrics", |
| 4022 | "parent" |
| 4023 | ] |
| 4024 | } |
| 4025 | }, |
| 4026 | "next_cursor": { |
| 4027 | "type": "string", |
| 4028 | "nullable": true, |
| 4029 | "description": "Opaque cursor for the next page; pass it back as `cursor`. Null when the page is empty." |
| 4030 | } |
| 4031 | }, |
| 4032 | "required": [ |
| 4033 | "logs", |
| 4034 | "next_cursor" |
| 4035 | ] |
| 4036 | } |
| 4037 | } |
| 4038 | } |
| 4039 | }, |
| 4040 | "400": { |
| 4041 | "description": "Bad request", |
| 4042 | "content": { |
| 4043 | "application/json": { |
| 4044 | "schema": { |
| 4045 | "$ref": "#/components/schemas/Error" |
| 4046 | } |
| 4047 | } |
| 4048 | } |
| 4049 | }, |
| 4050 | "401": { |
| 4051 | "description": "Unauthorized", |
| 4052 | "content": { |
| 4053 | "application/json": { |
| 4054 | "schema": { |
| 4055 | "$ref": "#/components/schemas/Error" |
| 4056 | } |
| 4057 | } |
| 4058 | } |
| 4059 | }, |
| 4060 | "500": { |
| 4061 | "description": "Internal server error", |
| 4062 | "content": { |
| 4063 | "application/json": { |
| 4064 | "schema": { |
| 4065 | "$ref": "#/components/schemas/Error" |
| 4066 | } |
| 4067 | } |
| 4068 | } |
| 4069 | } |
| 4070 | }, |
| 4071 | "x-api-version": "3.1" |
| 4072 | } |
| 4073 | }, |
| 4074 | "/api/v3.1/logs/tool_execution/{id}": { |
| 4075 | "get": { |
| 4076 | "summary": "Get log details by ID", |
| 4077 | "description": "Retrieve detailed log information by log ID.", |
| 4078 | "tags": [ |
| 4079 | "Logs" |
| 4080 | ], |
| 4081 | "operationId": "getLogsToolExecutionById", |
| 4082 | "security": [ |
| 4083 | { |
| 4084 | "ApiKeyAuth": [] |
| 4085 | } |
| 4086 | ], |
| 4087 | "parameters": [ |
| 4088 | { |
| 4089 | "schema": { |
| 4090 | "type": "string", |
| 4091 | "description": "The log ID" |
| 4092 | }, |
| 4093 | "required": true, |
| 4094 | "description": "The log ID", |
| 4095 | "name": "id", |
| 4096 | "in": "path" |
| 4097 | } |
| 4098 | ], |
| 4099 | "responses": { |
| 4100 | "200": { |
| 4101 | "description": "Successfully retrieved log details", |
| 4102 | "content": { |
| 4103 | "application/json": { |
| 4104 | "schema": { |
| 4105 | "type": "object", |
| 4106 | "properties": { |
| 4107 | "id": { |
| 4108 | "type": "string" |
| 4109 | }, |
| 4110 | "timestamp": { |
| 4111 | "type": "string", |
| 4112 | "format": "date-time", |
| 4113 | "description": "ISO 8601 timestamp" |
| 4114 | }, |
| 4115 | "type": { |
| 4116 | "type": "string", |
| 4117 | "description": "Log event type, e.g. tool.execution, trigger.message, connected_account.activated" |
| 4118 | }, |
| 4119 | "status": { |
| 4120 | "type": "string", |
| 4121 | "enum": [ |
| 4122 | "success", |
| 4123 | "failed" |
| 4124 | ] |
| 4125 | }, |
| 4126 | "level": { |
| 4127 | "type": "string", |
| 4128 | "enum": [ |
| 4129 | "info", |
| 4130 | "error", |
| 4131 | "warn" |
| 4132 | ] |
| 4133 | }, |
| 4134 | "message": { |
| 4135 | "type": "string" |
| 4136 | }, |
| 4137 | "metadata": { |
| 4138 | "type": "object", |
| 4139 | "properties": { |
| 4140 | "credential_source": { |
| 4141 | "type": "string", |
| 4142 | "enum": [ |
| 4143 | "connected_account", |
| 4144 | "instant_account", |
| 4145 | "custom_auth", |
| 4146 | "no_auth" |
| 4147 | ], |
| 4148 | "description": "Credential used for this execution. instant_account means a Composio Instant account. Omitted when no credential source was recorded." |
| 4149 | }, |
| 4150 | "instant_charge": { |
| 4151 | "type": "string", |
| 4152 | "description": "Instant charge in USD for this tool, as an exact decimal string. Omitted when no charge was recorded; zero is returned as the string 0." |
| 4153 | } |
| 4154 | }, |
| 4155 | "additionalProperties": {} |
| 4156 | }, |
| 4157 | "metrics": { |
| 4158 | "type": "object", |
| 4159 | "additionalProperties": {} |
| 4160 | }, |
| 4161 | "parent": { |
| 4162 | "type": "object", |
| 4163 | "nullable": true, |
| 4164 | "properties": { |
| 4165 | "log_id": { |
| 4166 | "type": "string" |
| 4167 | }, |
| 4168 | "tool_slug": { |
| 4169 | "type": "string" |
| 4170 | } |
| 4171 | }, |
| 4172 | "required": [ |
| 4173 | "log_id", |
| 4174 | "tool_slug" |
| 4175 | ] |
| 4176 | }, |
| 4177 | "timings": { |
| 4178 | "type": "object", |
| 4179 | "properties": { |
| 4180 | "start_time": { |
| 4181 | "type": "number", |
| 4182 | "description": "Epoch milliseconds" |
| 4183 | }, |
| 4184 | "end_time": { |
| 4185 | "type": "number", |
| 4186 | "description": "Epoch milliseconds" |
| 4187 | } |
| 4188 | }, |
| 4189 | "required": [ |
| 4190 | "start_time", |
| 4191 | "end_time" |
| 4192 | ] |
| 4193 | }, |
| 4194 | "context": { |
| 4195 | "type": "object", |
| 4196 | "properties": { |
| 4197 | "session_id": { |
| 4198 | "type": "string" |
| 4199 | }, |
| 4200 | "trace_id": { |
| 4201 | "type": "string" |
| 4202 | }, |
| 4203 | "request_id": { |
| 4204 | "type": "string" |
| 4205 | } |
| 4206 | } |
| 4207 | }, |
| 4208 | "source": { |
| 4209 | "type": "object", |
| 4210 | "properties": { |
| 4211 | "host": { |
| 4212 | "type": "string" |
| 4213 | }, |
| 4214 | "framework": { |
| 4215 | "type": "string" |
| 4216 | }, |
| 4217 | "language": { |
| 4218 | "type": "string" |
| 4219 | } |
| 4220 | } |
| 4221 | }, |
| 4222 | "data": { |
| 4223 | "type": "object", |
| 4224 | "additionalProperties": {} |
| 4225 | } |
| 4226 | }, |
| 4227 | "required": [ |
| 4228 | "id", |
| 4229 | "timestamp", |
| 4230 | "type", |
| 4231 | "status", |
| 4232 | "level", |
| 4233 | "metadata", |
| 4234 | "metrics", |
| 4235 | "parent", |
| 4236 | "context", |
| 4237 | "source", |
| 4238 | "data" |
| 4239 | ] |
| 4240 | } |
| 4241 | } |
| 4242 | } |
| 4243 | }, |
| 4244 | "400": { |
| 4245 | "description": "Bad request", |
| 4246 | "content": { |
| 4247 | "application/json": { |
| 4248 | "schema": { |
| 4249 | "$ref": "#/components/schemas/Error" |
| 4250 | } |
| 4251 | } |
| 4252 | } |
| 4253 | }, |
| 4254 | "401": { |
| 4255 | "description": "Unauthorized", |
| 4256 | "content": { |
| 4257 | "application/json": { |
| 4258 | "schema": { |
| 4259 | "$ref": "#/components/schemas/Error" |
| 4260 | } |
| 4261 | } |
| 4262 | } |
| 4263 | }, |
| 4264 | "404": { |
| 4265 | "description": "Log not found", |
| 4266 | "content": { |
| 4267 | "application/json": { |
| 4268 | "schema": { |
| 4269 | "$ref": "#/components/schemas/Error" |
| 4270 | } |
| 4271 | } |
| 4272 | } |
| 4273 | }, |
| 4274 | "500": { |
| 4275 | "description": "Internal server error", |
| 4276 | "content": { |
| 4277 | "application/json": { |
| 4278 | "schema": { |
| 4279 | "$ref": "#/components/schemas/Error" |
| 4280 | } |
| 4281 | } |
| 4282 | } |
| 4283 | } |
| 4284 | }, |
| 4285 | "x-api-version": "3.1" |
| 4286 | } |
| 4287 | }, |
| 4288 | "/api/v3.1/tools": { |
| 4289 | "get": { |
| 4290 | "summary": "List available tools", |
| 4291 | "description": "Retrieve a paginated list of available tools with comprehensive filtering, sorting and search capabilities. Use query parameters to narrow down results by toolkit, tags, or search terms.", |
| 4292 | "tags": [ |
| 4293 | "Tools" |
| 4294 | ], |
| 4295 | "operationId": "getTools", |
| 4296 | "security": [ |
| 4297 | { |
| 4298 | "ApiKeyAuth": [] |
| 4299 | }, |
| 4300 | { |
| 4301 | "UserApiKeyAuth": [] |
| 4302 | } |
| 4303 | ], |
| 4304 | "parameters": [ |
| 4305 | { |
| 4306 | "schema": { |
| 4307 | "type": "string" |
| 4308 | }, |
| 4309 | "required": false, |
| 4310 | "description": "The slug of the toolkit to filter by", |
| 4311 | "in": "query", |
| 4312 | "name": "toolkit_slug" |
| 4313 | }, |
| 4314 | { |
| 4315 | "schema": { |
| 4316 | "type": "string" |
| 4317 | }, |
| 4318 | "required": false, |
| 4319 | "description": "Comma-separated list of specific tool slugs to retrieve (overrides other filters)", |
| 4320 | "in": "query", |
| 4321 | "name": "tool_slugs" |
| 4322 | }, |
| 4323 | { |
| 4324 | "schema": { |
| 4325 | "oneOf": [ |
| 4326 | { |
| 4327 | "type": "string" |
| 4328 | }, |
| 4329 | { |
| 4330 | "type": "array", |
| 4331 | "items": { |
| 4332 | "type": "string" |
| 4333 | } |
| 4334 | } |
| 4335 | ] |
| 4336 | }, |
| 4337 | "required": false, |
| 4338 | "description": "DEPRECATED: This parameter will be removed in a future version. Filter directly instead with tool_slugs and toolkit_slug, which accepts a comma-separated list of toolkits.", |
| 4339 | "in": "query", |
| 4340 | "name": "auth_config_ids", |
| 4341 | "deprecated": true |
| 4342 | }, |
| 4343 | { |
| 4344 | "schema": { |
| 4345 | "type": "string", |
| 4346 | "enum": [ |
| 4347 | "true", |
| 4348 | "false" |
| 4349 | ] |
| 4350 | }, |
| 4351 | "required": false, |
| 4352 | "description": "Filter to only show important/featured tools (set to \"true\" to enable)", |
| 4353 | "in": "query", |
| 4354 | "name": "important" |
| 4355 | }, |
| 4356 | { |
| 4357 | "schema": { |
| 4358 | "type": "array", |
| 4359 | "items": { |
| 4360 | "type": "string" |
| 4361 | } |
| 4362 | }, |
| 4363 | "required": false, |
| 4364 | "description": "Filter tools by one or more tags (can be specified multiple times)", |
| 4365 | "in": "query", |
| 4366 | "name": "tags" |
| 4367 | }, |
| 4368 | { |
| 4369 | "schema": { |
| 4370 | "type": "array", |
| 4371 | "nullable": true, |
| 4372 | "items": { |
| 4373 | "type": "string" |
| 4374 | }, |
| 4375 | "description": "Filter tools by one or more scopes (can be specified multiple times)" |
| 4376 | }, |
| 4377 | "required": false, |
| 4378 | "description": "Array of scopes to filter tools by)", |
| 4379 | "name": "scopes", |
| 4380 | "in": "query" |
| 4381 | }, |
| 4382 | { |
| 4383 | "schema": { |
| 4384 | "type": "string" |
| 4385 | }, |
| 4386 | "required": false, |
| 4387 | "description": "Full-text search query to filter tools by name, slug, or description. Applied as a soft filter on top of other filters.", |
| 4388 | "in": "query", |
| 4389 | "name": "query" |
| 4390 | }, |
| 4391 | { |
| 4392 | "schema": { |
| 4393 | "type": "string" |
| 4394 | }, |
| 4395 | "required": false, |
| 4396 | "description": "Deprecated: use \"query\" instead. Free-text search query to find tools by name, description, or functionality.", |
| 4397 | "in": "query", |
| 4398 | "name": "search", |
| 4399 | "deprecated": true |
| 4400 | }, |
| 4401 | { |
| 4402 | "schema": { |
| 4403 | "type": "boolean", |
| 4404 | "default": true |
| 4405 | }, |
| 4406 | "required": false, |
| 4407 | "description": "Include deprecated tools in the response", |
| 4408 | "in": "query", |
| 4409 | "name": "include_deprecated" |
| 4410 | }, |
| 4411 | { |
| 4412 | "schema": { |
| 4413 | "type": "boolean", |
| 4414 | "default": false |
| 4415 | }, |
| 4416 | "required": false, |
| 4417 | "description": "Whether to include published pricing within instant, when available. Defaults to false.", |
| 4418 | "in": "query", |
| 4419 | "name": "include_pricing" |
| 4420 | }, |
| 4421 | { |
| 4422 | "schema": { |
| 4423 | "oneOf": [ |
| 4424 | { |
| 4425 | "type": "null" |
| 4426 | }, |
| 4427 | { |
| 4428 | "type": "string" |
| 4429 | }, |
| 4430 | { |
| 4431 | "type": "object", |
| 4432 | "additionalProperties": { |
| 4433 | "type": "string" |
| 4434 | }, |
| 4435 | "description": "Object representation of parsed bracket notation" |
| 4436 | } |
| 4437 | ] |
| 4438 | }, |
| 4439 | "required": false, |
| 4440 | "description": "Toolkit version specification. Use \"latest\" for latest versions or bracket notation for specific versions per toolkit. Defaults to the latest published version (\"latest\") when omitted.", |
| 4441 | "in": "query", |
| 4442 | "name": "toolkit_versions", |
| 4443 | "examples": { |
| 4444 | "latest_version": { |
| 4445 | "summary": "Latest version for all toolkits", |
| 4446 | "value": "latest" |
| 4447 | }, |
| 4448 | "bracket_notation": { |
| 4449 | "summary": "Specific versions using bracket notation", |
| 4450 | "value": "Use: toolkit_versions[gmail]=20250930_00&toolkit_versions[slack]=20250929_00" |
| 4451 | }, |
| 4452 | "null_value": { |
| 4453 | "summary": "No version specified (uses latest)", |
| 4454 | "value": null |
| 4455 | } |
| 4456 | } |
| 4457 | }, |
| 4458 | { |
| 4459 | "schema": { |
| 4460 | "type": "string", |
| 4461 | "minLength": 1, |
| 4462 | "maxLength": 256, |
| 4463 | "description": "Include the tools of the custom toolkits this user can use. Without it, only tools of custom toolkits with access \"all\" are listed.", |
| 4464 | "example": "user_123" |
| 4465 | }, |
| 4466 | "required": false, |
| 4467 | "description": "Include the tools of the custom toolkits this user can use. Without it, only tools of custom toolkits with access \"all\" are listed.", |
| 4468 | "name": "user_id", |
| 4469 | "in": "query" |
| 4470 | }, |
| 4471 | { |
| 4472 | "schema": { |
| 4473 | "type": "number", |
| 4474 | "nullable": true |
| 4475 | }, |
| 4476 | "required": false, |
| 4477 | "description": "Number of items per page, max allowed is 1000", |
| 4478 | "name": "limit", |
| 4479 | "in": "query" |
| 4480 | }, |
| 4481 | { |
| 4482 | "schema": { |
| 4483 | "type": "string" |
| 4484 | }, |
| 4485 | "required": false, |
| 4486 | "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.", |
| 4487 | "name": "cursor", |
| 4488 | "in": "query" |
| 4489 | } |
| 4490 | ], |
| 4491 | "responses": { |
| 4492 | "200": { |
| 4493 | "description": "Successfully retrieved tools list with pagination information", |
| 4494 | "content": { |
| 4495 | "application/json": { |
| 4496 | "schema": { |
| 4497 | "$ref": "#/components/schemas/ToolsPaginated" |
| 4498 | } |
| 4499 | } |
| 4500 | } |
| 4501 | }, |
| 4502 | "400": { |
| 4503 | "description": "Bad request - Invalid query parameters", |
| 4504 | "content": { |
| 4505 | "application/json": { |
| 4506 | "schema": { |
| 4507 | "$ref": "#/components/schemas/Error" |
| 4508 | } |
| 4509 | } |
| 4510 | } |
| 4511 | }, |
| 4512 | "401": { |
| 4513 | "description": "Unauthorized - Authentication credentials are missing or invalid", |
| 4514 | "content": { |
| 4515 | "application/json": { |
| 4516 | "schema": { |
| 4517 | "$ref": "#/components/schemas/Error" |
| 4518 | } |
| 4519 | } |
| 4520 | } |
| 4521 | }, |
| 4522 | "403": { |
| 4523 | "description": "Forbidden - User does not have permission to access tools", |
| 4524 | "content": { |
| 4525 | "application/json": { |
| 4526 | "schema": { |
| 4527 | "$ref": "#/components/schemas/Error" |
| 4528 | } |
| 4529 | } |
| 4530 | } |
| 4531 | }, |
| 4532 | "404": { |
| 4533 | "description": "Not found - The requested resource was not found", |
| 4534 | "content": { |
| 4535 | "application/json": { |
| 4536 | "schema": { |
| 4537 | "$ref": "#/components/schemas/Error" |
| 4538 | } |
| 4539 | } |
| 4540 | } |
| 4541 | }, |
| 4542 | "429": { |
| 4543 | "description": "Too many requests - Rate limit exceeded", |
| 4544 | "content": { |
| 4545 | "application/json": { |
| 4546 | "schema": { |
| 4547 | "$ref": "#/components/schemas/Error" |
| 4548 | } |
| 4549 | } |
| 4550 | } |
| 4551 | }, |
| 4552 | "500": { |
| 4553 | "description": "Internal server error - Something went wrong on the server", |
| 4554 | "content": { |
| 4555 | "application/json": { |
| 4556 | "schema": { |
| 4557 | "$ref": "#/components/schemas/Error" |
| 4558 | } |
| 4559 | } |
| 4560 | } |
| 4561 | } |
| 4562 | }, |
| 4563 | "x-api-version": "3.1" |
| 4564 | } |
| 4565 | }, |
| 4566 | "/api/v3.1/tools/enum": { |
| 4567 | "get": { |
| 4568 | "summary": "Get tool enum list", |
| 4569 | "description": "Lists the slug of every tool in the latest version of each Composio-managed toolkit, such as GMAIL_SEND_EMAIL. Tools of custom toolkits are not included.", |
| 4570 | "tags": [ |
| 4571 | "Tools" |
| 4572 | ], |
| 4573 | "operationId": "getToolsEnum", |
| 4574 | "security": [ |
| 4575 | { |
| 4576 | "ApiKeyAuth": [] |
| 4577 | }, |
| 4578 | { |
| 4579 | "UserApiKeyAuth": [] |
| 4580 | } |
| 4581 | ], |
| 4582 | "responses": { |
| 4583 | "200": { |
| 4584 | "description": "Successfully retrieved tool enum list", |
| 4585 | "content": { |
| 4586 | "application/json": { |
| 4587 | "schema": { |
| 4588 | "type": "array", |
| 4589 | "items": { |
| 4590 | "type": "string" |
| 4591 | }, |
| 4592 | "description": "Tool slugs" |
| 4593 | } |
| 4594 | } |
| 4595 | } |
| 4596 | }, |
| 4597 | "400": { |
| 4598 | "description": "Bad request - Invalid request parameters", |
| 4599 | "content": { |
| 4600 | "application/json": { |
| 4601 | "schema": { |
| 4602 | "$ref": "#/components/schemas/Error" |
| 4603 | } |
| 4604 | } |
| 4605 | } |
| 4606 | }, |
| 4607 | "401": { |
| 4608 | "description": "Unauthorized - Authentication credentials are missing or invalid", |
| 4609 | "content": { |
| 4610 | "application/json": { |
| 4611 | "schema": { |
| 4612 | "$ref": "#/components/schemas/Error" |
| 4613 | } |
| 4614 | } |
| 4615 | } |
| 4616 | }, |
| 4617 | "403": { |
| 4618 | "description": "Forbidden - User does not have permission to access tool enums", |
| 4619 | "content": { |
| 4620 | "application/json": { |
| 4621 | "schema": { |
| 4622 | "$ref": "#/components/schemas/Error" |
| 4623 | } |
| 4624 | } |
| 4625 | } |
| 4626 | }, |
| 4627 | "404": { |
| 4628 | "description": "Not found - Tool enum list not found", |
| 4629 | "content": { |
| 4630 | "application/json": { |
| 4631 | "schema": { |
| 4632 | "$ref": "#/components/schemas/Error" |
| 4633 | } |
| 4634 | } |
| 4635 | } |
| 4636 | }, |
| 4637 | "500": { |
| 4638 | "description": "Internal server error - Something went wrong on the server", |
| 4639 | "content": { |
| 4640 | "application/json": { |
| 4641 | "schema": { |
| 4642 | "$ref": "#/components/schemas/Error" |
| 4643 | } |
| 4644 | } |
| 4645 | } |
| 4646 | } |
| 4647 | }, |
| 4648 | "x-api-version": "3.1" |
| 4649 | } |
| 4650 | }, |
| 4651 | "/api/v3.1/tools/{tool_slug}": { |
| 4652 | "get": { |
| 4653 | "summary": "Get tool by slug", |
| 4654 | "description": "Retrieve detailed information about a specific tool using its slug identifier. This endpoint returns full metadata about a tool including input/output parameters, versions, and toolkit information.", |
| 4655 | "tags": [ |
| 4656 | "Tools" |
| 4657 | ], |
| 4658 | "operationId": "getToolsByToolSlug", |
| 4659 | "security": [ |
| 4660 | { |
| 4661 | "ApiKeyAuth": [] |
| 4662 | }, |
| 4663 | { |
| 4664 | "UserApiKeyAuth": [] |
| 4665 | } |
| 4666 | ], |
| 4667 | "parameters": [ |
| 4668 | { |
| 4669 | "schema": { |
| 4670 | "type": "string" |
| 4671 | }, |
| 4672 | "required": true, |
| 4673 | "description": "The unique slug identifier of the tool", |
| 4674 | "name": "tool_slug", |
| 4675 | "in": "path" |
| 4676 | }, |
| 4677 | { |
| 4678 | "schema": { |
| 4679 | "type": "boolean", |
| 4680 | "default": false |
| 4681 | }, |
| 4682 | "required": false, |
| 4683 | "description": "Whether to include published pricing within instant, when available. Defaults to false.", |
| 4684 | "in": "query", |
| 4685 | "name": "include_pricing" |
| 4686 | }, |
| 4687 | { |
| 4688 | "schema": { |
| 4689 | "type": "string" |
| 4690 | }, |
| 4691 | "required": false, |
| 4692 | "description": "Optional version of the tool to retrieve. Takes precedence over toolkit_versions; when both are omitted the tool resolves to the latest published version (\"latest\").", |
| 4693 | "name": "version", |
| 4694 | "in": "query" |
| 4695 | }, |
| 4696 | { |
| 4697 | "schema": { |
| 4698 | "oneOf": [ |
| 4699 | { |
| 4700 | "type": "null" |
| 4701 | }, |
| 4702 | { |
| 4703 | "type": "string" |
| 4704 | }, |
| 4705 | { |
| 4706 | "type": "object", |
| 4707 | "additionalProperties": { |
| 4708 | "type": "string" |
| 4709 | }, |
| 4710 | "description": "Object representation of parsed bracket notation" |
| 4711 | } |
| 4712 | ] |
| 4713 | }, |
| 4714 | "required": false, |
| 4715 | "description": "Toolkit version specification. Use \"latest\" for latest versions or bracket notation for specific versions per toolkit. Read only when version is omitted; when neither is supplied the tool resolves to the latest published version (\"latest\").", |
| 4716 | "in": "query", |
| 4717 | "name": "toolkit_versions", |
| 4718 | "examples": { |
| 4719 | "latest_version": { |
| 4720 | "summary": "Latest version for all toolkits", |
| 4721 | "value": "latest" |
| 4722 | }, |
| 4723 | "bracket_notation": { |
| 4724 | "summary": "Specific versions using bracket notation", |
| 4725 | "value": "Use: toolkit_versions[gmail]=20250930_00&toolkit_versions[slack]=20250929_00" |
| 4726 | }, |
| 4727 | "null_value": { |
| 4728 | "summary": "No version specified (uses latest)", |
| 4729 | "value": null |
| 4730 | } |
| 4731 | } |
| 4732 | } |
| 4733 | ], |
| 4734 | "responses": { |
| 4735 | "200": { |
| 4736 | "description": "Successfully retrieved tool details", |
| 4737 | "content": { |
| 4738 | "application/json": { |
| 4739 | "schema": { |
| 4740 | "$ref": "#/components/schemas/ToolDetails" |
| 4741 | } |
| 4742 | } |
| 4743 | } |
| 4744 | }, |
| 4745 | "400": { |
| 4746 | "description": "Bad request - Invalid tool slug format", |
| 4747 | "content": { |
| 4748 | "application/json": { |
| 4749 | "schema": { |
| 4750 | "$ref": "#/components/schemas/Error" |
| 4751 | } |
| 4752 | } |
| 4753 | } |
| 4754 | }, |
| 4755 | "401": { |
| 4756 | "description": "Unauthorized - Authentication credentials are missing or invalid", |
| 4757 | "content": { |
| 4758 | "application/json": { |
| 4759 | "schema": { |
| 4760 | "$ref": "#/components/schemas/Error" |
| 4761 | } |
| 4762 | } |
| 4763 | } |
| 4764 | }, |
| 4765 | "404": { |
| 4766 | "description": "Not found - Tool with the specified slug does not exist", |
| 4767 | "content": { |
| 4768 | "application/json": { |
| 4769 | "schema": { |
| 4770 | "$ref": "#/components/schemas/Error" |
| 4771 | } |
| 4772 | } |
| 4773 | } |
| 4774 | }, |
| 4775 | "500": { |
| 4776 | "description": "Internal server error - Something went wrong on the server", |
| 4777 | "content": { |
| 4778 | "application/json": { |
| 4779 | "schema": { |
| 4780 | "$ref": "#/components/schemas/Error" |
| 4781 | } |
| 4782 | } |
| 4783 | } |
| 4784 | } |
| 4785 | }, |
| 4786 | "x-api-version": "3.1" |
| 4787 | } |
| 4788 | }, |
| 4789 | "/api/v3.1/tools/execute/{tool_slug}": { |
| 4790 | "post": { |
| 4791 | "summary": "Execute tool", |
| 4792 | "description": "Execute a specific tool operation with provided arguments and authentication. This is the primary endpoint for integrating with third-party services and executing tools. You can provide structured arguments or use natural language processing by providing a text description of what you want to accomplish.", |
| 4793 | "tags": [ |
| 4794 | "Tools" |
| 4795 | ], |
| 4796 | "operationId": "postToolsExecuteByToolSlug", |
| 4797 | "security": [ |
| 4798 | { |
| 4799 | "ApiKeyAuth": [] |
| 4800 | }, |
| 4801 | { |
| 4802 | "UserApiKeyAuth": [] |
| 4803 | } |
| 4804 | ], |
| 4805 | "parameters": [ |
| 4806 | { |
| 4807 | "schema": { |
| 4808 | "type": "string" |
| 4809 | }, |
| 4810 | "required": true, |
| 4811 | "description": "The tool slug to execute", |
| 4812 | "name": "tool_slug", |
| 4813 | "in": "path" |
| 4814 | }, |
| 4815 | { |
| 4816 | "schema": { |
| 4817 | "type": "string", |
| 4818 | "description": "JSON object containing custom headers to pass to LLM providers (OpenAI, Bedrock, etc.)", |
| 4819 | "example": "{\"x-custom-header\": \"value\", \"authorization\": \"Bearer token\"}" |
| 4820 | }, |
| 4821 | "required": false, |
| 4822 | "name": "x-llm-gateway-headers", |
| 4823 | "in": "header" |
| 4824 | } |
| 4825 | ], |
| 4826 | "requestBody": { |
| 4827 | "content": { |
| 4828 | "application/json": { |
| 4829 | "schema": { |
| 4830 | "type": "object", |
| 4831 | "properties": { |
| 4832 | "connected_account_id": { |
| 4833 | "anyOf": [ |
| 4834 | { |
| 4835 | "type": "string", |
| 4836 | "enum": [ |
| 4837 | "instant_account" |
| 4838 | ] |
| 4839 | }, |
| 4840 | { |
| 4841 | "type": "string", |
| 4842 | "format": "connectedAccountId" |
| 4843 | } |
| 4844 | ], |
| 4845 | "description": "Unique identifier for the connected account to use for authentication. Pass `instant_account` to run the tool on the Composio instant account for its toolkit, even when the user has connected the toolkit themselves; the request fails rather than falling back to another credential.", |
| 4846 | "example": "ca_1a2b3c4d5e6f" |
| 4847 | }, |
| 4848 | "entity_id": { |
| 4849 | "type": "string", |
| 4850 | "description": "Deprecated: please use user_id instead. Entity identifier for multi-entity connected accounts (e.g. multiple repositories, organizations)", |
| 4851 | "example": "repo-123", |
| 4852 | "deprecated": true |
| 4853 | }, |
| 4854 | "user_id": { |
| 4855 | "type": "string", |
| 4856 | "description": "User id for multi-user connected accounts (e.g. multiple users, organizations)", |
| 4857 | "example": "user-123" |
| 4858 | }, |
| 4859 | "version": { |
| 4860 | "type": "string", |
| 4861 | "description": "Tool version to execute. Defaults to the latest published version (\"latest\") when omitted.", |
| 4862 | "example": "latest" |
| 4863 | }, |
| 4864 | "custom_auth_params": { |
| 4865 | "type": "object", |
| 4866 | "properties": { |
| 4867 | "base_url": { |
| 4868 | "type": "string", |
| 4869 | "description": "The base URL (root address) what you should use while making http requests to the connected account. For example, for gmail, it would be 'https://gmail.googleapis.com'" |
| 4870 | }, |
| 4871 | "parameters": { |
| 4872 | "type": "array", |
| 4873 | "items": { |
| 4874 | "type": "object", |
| 4875 | "properties": { |
| 4876 | "name": { |
| 4877 | "type": "string", |
| 4878 | "description": "The name of the parameter. For example, 'x-api-key', 'Content-Type', etc." |
| 4879 | }, |
| 4880 | "in": { |
| 4881 | "type": "string", |
| 4882 | "enum": [ |
| 4883 | "query", |
| 4884 | "header" |
| 4885 | ], |
| 4886 | "description": "The location of the parameter. Can be 'query' or 'header'." |
| 4887 | }, |
| 4888 | "value": { |
| 4889 | "anyOf": [ |
| 4890 | { |
| 4891 | "type": "string" |
| 4892 | }, |
| 4893 | { |
| 4894 | "type": "number" |
| 4895 | } |
| 4896 | ], |
| 4897 | "description": "The value of the parameter. For example, '1234567890', 'application/json', etc." |
| 4898 | } |
| 4899 | }, |
| 4900 | "required": [ |
| 4901 | "name", |
| 4902 | "in", |
| 4903 | "value" |
| 4904 | ] |
| 4905 | } |
| 4906 | }, |
| 4907 | "body": { |
| 4908 | "type": "object", |
| 4909 | "additionalProperties": {}, |
| 4910 | "description": "The body to be sent to the endpoint for authentication. This is a JSON object. Note: This is very rarely needed and is only required by very few apps." |
| 4911 | } |
| 4912 | }, |
| 4913 | "description": "Custom authentication parameters for tools that support parameterized authentication", |
| 4914 | "example": { |
| 4915 | "base_url": "https://api.example.com", |
| 4916 | "parameters": [ |
| 4917 | { |
| 4918 | "name": "x-api-key", |
| 4919 | "value": "secret-key", |
| 4920 | "in": "header" |
| 4921 | } |
| 4922 | ] |
| 4923 | } |
| 4924 | }, |
| 4925 | "custom_connection_data": { |
| 4926 | "description": "Custom connection data for tools that support custom connection data", |
| 4927 | "example": { |
| 4928 | "authScheme": "OAUTH2", |
| 4929 | "toolkitSlug": "github", |
| 4930 | "val": { |
| 4931 | "access_token": "secret-token" |
| 4932 | } |
| 4933 | }, |
| 4934 | "type": "object", |
| 4935 | "properties": { |
| 4936 | "authScheme": { |
| 4937 | "type": "string", |
| 4938 | "enum": [ |
| 4939 | "OAUTH2", |
| 4940 | "DCR_OAUTH", |
| 4941 | "API_KEY", |
| 4942 | "BASIC_WITH_JWT", |
| 4943 | "BASIC", |
| 4944 | "BEARER_TOKEN", |
| 4945 | "OAUTH1", |
| 4946 | "NO_AUTH", |
| 4947 | "SERVICE_ACCOUNT", |
| 4948 | "GOOGLE_SERVICE_ACCOUNT", |
| 4949 | "S2S_OAUTH2" |
| 4950 | ] |
| 4951 | }, |
| 4952 | "toolkitSlug": { |
| 4953 | "type": "string" |
| 4954 | }, |
| 4955 | "val": { |
| 4956 | "type": "object", |
| 4957 | "properties": { |
| 4958 | "subdomain": { |
| 4959 | "type": "string" |
| 4960 | }, |
| 4961 | "your-domain": { |
| 4962 | "type": "string" |
| 4963 | }, |
| 4964 | "region": { |
| 4965 | "type": "string" |
| 4966 | }, |
| 4967 | "shop": { |
| 4968 | "type": "string" |
| 4969 | }, |
| 4970 | "account_url": { |
| 4971 | "type": "string" |
| 4972 | }, |
| 4973 | "COMPANYDOMAIN": { |
| 4974 | "type": "string" |
| 4975 | }, |
| 4976 | "extension": { |
| 4977 | "type": "string" |
| 4978 | }, |
| 4979 | "form_api_base_url": { |
| 4980 | "type": "string" |
| 4981 | }, |
| 4982 | "instanceEndpoint": { |
| 4983 | "type": "string" |
| 4984 | }, |
| 4985 | "api_url": { |
| 4986 | "type": "string" |
| 4987 | }, |
| 4988 | "borneo_dashboard_url": { |
| 4989 | "type": "string" |
| 4990 | }, |
| 4991 | "proxy_username": { |
| 4992 | "type": "string" |
| 4993 | }, |
| 4994 | "proxy_password": { |
| 4995 | "type": "string" |
| 4996 | }, |
| 4997 | "domain": { |
| 4998 | "type": "string" |
| 4999 | }, |
| 5000 | "version": { |
Showing first 5,000 of 33,292 lines.
View raw