1openapi: 3.1.0 2info: 3 title: AI Software Factory — Public API v1 4 version: 1.0.0 5 description: >- 6 The public REST API of AI Software Factory. Base URL: `/api/v1`. 7 8 9 ## Versioning 10 11 `/api/v1` is the STABLE surface. Breaking changes ship only in a new major (`/api/v2`, side-by-side). A deprecated 12 route carries `Deprecation: true` + `Sunset: <RFC 1123 date>` headers and `deprecated: true` here. See 13 `docs/api/versioning.md`. 14 15 16 ## Authentication 17 18 Send `Authorization: Bearer <token>` where `<token>` is either a user JWT (web sessions) or an API key 19 (`fk_live_…`). API keys act as their WORKSPACE (docs §7) and carry scopes `READ` / `WRITE` / `ADMIN`; a 20 scope-insufficient call returns `403 FORBIDDEN` with `error.details[0].reason = "api_key_scope_write"` (public alias 21 **SCOPE_DENIED**), a cross-workspace call returns `403 … "workspace_mismatch"`. The `:workspaceId` path segment is 22 the authoritative workspace selector; the optional `X-Factory-Workspace` header disambiguates multi-workspace users 23 and MUST equal the key's own workspace when present. 24 25 26 ## Rate limits 27 28 Every response carries `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. Per API key: 600 req/min 29 by default, or the key's own `rateLimit` if set (docs §11). 30 31 32 ## Idempotency 33 34 Mutating requests may carry an `Idempotency-Key` header; 2xx responses are memoized for 24 h and replays carry 35 `Idempotency-Replayed: true` (docs §9). 36 37 38 ## Errors 39 40 Every non-2xx response is `{ "error": { "code", "message", "details"?, "requestId" } }` (`details[].reason` is the 41 machine-readable reason). See `docs/api/authentication.md` §9 for the canonical code table. 42servers: 43 - url: /api/v1 44 description: Public API v1 (same-origin). Use the absolute URL in deployments. 45tags: 46 - name: AI Conversations 47 description: AI Conversations endpoints (v1). 48 - name: Auth 49 description: Auth endpoints (v1). 50 - name: Automations 51 description: Automations endpoints (v1). 52 - name: Blocks 53 description: Blocks endpoints (v1). 54 - name: Comments 55 description: Comments endpoints (v1). 56 - name: Databases 57 description: Databases endpoints (v1). 58 - name: Debug 59 description: Debug endpoints (v1). 60 - name: API Docs 61 description: API Docs endpoints (v1). 62 - name: Files 63 description: Files endpoints (v1). 64 - name: Forms 65 description: Forms endpoints (v1). 66 - name: Health 67 description: Health endpoints (v1). 68 - name: Notifications 69 description: Notifications endpoints (v1). 70 - name: OAuth2 71 description: OAuth2 endpoints (v1). 72 - name: Orgs 73 description: Orgs endpoints (v1). 74 - name: Pages 75 description: Pages endpoints (v1). 76 - name: Public Forms 77 description: Public Forms endpoints (v1). 78 - name: Records 79 description: Records endpoints (v1). 80 - name: Search 81 description: Search endpoints (v1). 82 - name: Sessions 83 description: Sessions endpoints (v1). 84 - name: Sharing 85 description: Sharing endpoints (v1). 86 - name: Templates 87 description: Templates endpoints (v1). 88 - name: Users 89 description: Users endpoints (v1). 90 - name: Webhooks 91 description: Webhooks endpoints (v1). 92 - name: Workspaces 93 description: Workspaces endpoints (v1). 94 - name: AI 95 description: AI endpoints (v1). 96 - name: API Keys 97 description: API Keys endpoints (v1). 98 - name: Audit 99 description: Audit endpoints (v1). 100 - name: Embeds 101 description: Embeds endpoints (v1). 102 - name: Integrations 103 description: Integrations endpoints (v1). 104 - name: Policy 105 description: Policy endpoints (v1). 106 - name: Tasks 107 description: Tasks endpoints (v1). 108 - name: Teams 109 description: Teams endpoints (v1). 110paths: 111 /ai/conversations/{id}: 112 get: 113 operationId: GetAiConversationsById 114 tags: 115 - AI Conversations 116 summary: Get an AI conversation (user-identity only) 117 security: 118 - bearerAuth: [] 119 parameters: 120 - name: id 121 in: path 122 required: true 123 schema: 124 type: string 125 responses: 126 "200": 127 description: OK. 128 content: 129 application/json: 130 schema: 131 type: object 132 "401": 133 $ref: "#/components/responses/Err401" 134 description: UNAUTHORIZED — missing/invalid credentials. 135 "403": 136 $ref: "#/components/responses/Err403" 137 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 138 "404": 139 $ref: "#/components/responses/Err404" 140 description: NOT_FOUND — resource does not exist for this caller. 141 "429": 142 $ref: "#/components/responses/Err429" 143 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 144 "500": 145 $ref: "#/components/responses/Err500" 146 description: INTERNAL_ERROR — unexpected server error. 147 patch: 148 operationId: PatchAiConversationsById 149 tags: 150 - AI Conversations 151 summary: Update an AI conversation (user-identity only) 152 security: 153 - bearerAuth: [] 154 parameters: 155 - name: id 156 in: path 157 required: true 158 schema: 159 type: string 160 - $ref: "#/components/parameters/IdempotencyKey" 161 responses: 162 "200": 163 description: OK. 164 content: 165 application/json: 166 schema: 167 type: object 168 "400": 169 $ref: "#/components/responses/Err400" 170 description: VALIDATION_ERROR — request validation failed. 171 "401": 172 $ref: "#/components/responses/Err401" 173 description: UNAUTHORIZED — missing/invalid credentials. 174 "403": 175 $ref: "#/components/responses/Err403" 176 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 177 "404": 178 $ref: "#/components/responses/Err404" 179 description: NOT_FOUND — resource does not exist for this caller. 180 "409": 181 $ref: "#/components/responses/Err409" 182 description: CONFLICT — duplicate or state conflict. 183 "429": 184 $ref: "#/components/responses/Err429" 185 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 186 "500": 187 $ref: "#/components/responses/Err500" 188 description: INTERNAL_ERROR — unexpected server error. 189 delete: 190 operationId: DeleteAiConversationsById 191 tags: 192 - AI Conversations 193 summary: Delete an AI conversation (user-identity only) 194 security: 195 - bearerAuth: [] 196 parameters: 197 - name: id 198 in: path 199 required: true 200 schema: 201 type: string 202 - $ref: "#/components/parameters/IdempotencyKey" 203 responses: 204 "200": 205 description: OK. 206 content: 207 application/json: 208 schema: 209 type: object 210 "400": 211 $ref: "#/components/responses/Err400" 212 description: VALIDATION_ERROR — request validation failed. 213 "401": 214 $ref: "#/components/responses/Err401" 215 description: UNAUTHORIZED — missing/invalid credentials. 216 "403": 217 $ref: "#/components/responses/Err403" 218 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 219 "404": 220 $ref: "#/components/responses/Err404" 221 description: NOT_FOUND — resource does not exist for this caller. 222 "429": 223 $ref: "#/components/responses/Err429" 224 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 225 "500": 226 $ref: "#/components/responses/Err500" 227 description: INTERNAL_ERROR — unexpected server error. 228 /ai/conversations/{id}/messages: 229 get: 230 operationId: GetAiConversationsByIdMessages 231 tags: 232 - AI Conversations 233 summary: List conversation messages (user-identity only) 234 security: 235 - bearerAuth: [] 236 parameters: 237 - name: id 238 in: path 239 required: true 240 schema: 241 type: string 242 responses: 243 "200": 244 description: OK. 245 content: 246 application/json: 247 schema: 248 type: object 249 "401": 250 $ref: "#/components/responses/Err401" 251 description: UNAUTHORIZED — missing/invalid credentials. 252 "403": 253 $ref: "#/components/responses/Err403" 254 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 255 "404": 256 $ref: "#/components/responses/Err404" 257 description: NOT_FOUND — resource does not exist for this caller. 258 "429": 259 $ref: "#/components/responses/Err429" 260 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 261 "500": 262 $ref: "#/components/responses/Err500" 263 description: INTERNAL_ERROR — unexpected server error. 264 /auth/2fa/disable: 265 post: 266 operationId: PostAuth2faDisable 267 tags: 268 - Auth 269 summary: Create auth 270 security: 271 - bearerAuth: [] 272 parameters: 273 - $ref: "#/components/parameters/IdempotencyKey" 274 responses: 275 "200": 276 description: OK. 277 content: 278 application/json: 279 schema: 280 type: object 281 "400": 282 $ref: "#/components/responses/Err400" 283 description: VALIDATION_ERROR — request validation failed. 284 "401": 285 $ref: "#/components/responses/Err401" 286 description: UNAUTHORIZED — missing/invalid credentials. 287 "403": 288 $ref: "#/components/responses/Err403" 289 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 290 "404": 291 $ref: "#/components/responses/Err404" 292 description: NOT_FOUND — resource does not exist for this caller. 293 "429": 294 $ref: "#/components/responses/Err429" 295 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 296 "500": 297 $ref: "#/components/responses/Err500" 298 description: INTERNAL_ERROR — unexpected server error. 299 /auth/2fa/enroll: 300 post: 301 operationId: PostAuth2faEnroll 302 tags: 303 - Auth 304 summary: Create auth 305 security: 306 - bearerAuth: [] 307 parameters: 308 - $ref: "#/components/parameters/IdempotencyKey" 309 responses: 310 "200": 311 description: OK. 312 content: 313 application/json: 314 schema: 315 type: object 316 "400": 317 $ref: "#/components/responses/Err400" 318 description: VALIDATION_ERROR — request validation failed. 319 "401": 320 $ref: "#/components/responses/Err401" 321 description: UNAUTHORIZED — missing/invalid credentials. 322 "403": 323 $ref: "#/components/responses/Err403" 324 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 325 "404": 326 $ref: "#/components/responses/Err404" 327 description: NOT_FOUND — resource does not exist for this caller. 328 "429": 329 $ref: "#/components/responses/Err429" 330 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 331 "500": 332 $ref: "#/components/responses/Err500" 333 description: INTERNAL_ERROR — unexpected server error. 334 /auth/2fa/status: 335 get: 336 operationId: GetAuth2faStatus 337 tags: 338 - Auth 339 summary: List auth 340 security: 341 - bearerAuth: [] 342 parameters: [] 343 responses: 344 "200": 345 description: OK. 346 content: 347 application/json: 348 schema: 349 type: object 350 "401": 351 $ref: "#/components/responses/Err401" 352 description: UNAUTHORIZED — missing/invalid credentials. 353 "403": 354 $ref: "#/components/responses/Err403" 355 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 356 "404": 357 $ref: "#/components/responses/Err404" 358 description: NOT_FOUND — resource does not exist for this caller. 359 "429": 360 $ref: "#/components/responses/Err429" 361 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 362 "500": 363 $ref: "#/components/responses/Err500" 364 description: INTERNAL_ERROR — unexpected server error. 365 /auth/2fa/verify: 366 post: 367 operationId: PostAuth2faVerify 368 tags: 369 - Auth 370 summary: Create auth 371 security: 372 - bearerAuth: [] 373 parameters: 374 - $ref: "#/components/parameters/IdempotencyKey" 375 responses: 376 "200": 377 description: OK. 378 content: 379 application/json: 380 schema: 381 type: object 382 "400": 383 $ref: "#/components/responses/Err400" 384 description: VALIDATION_ERROR — request validation failed. 385 "401": 386 $ref: "#/components/responses/Err401" 387 description: UNAUTHORIZED — missing/invalid credentials. 388 "403": 389 $ref: "#/components/responses/Err403" 390 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 391 "404": 392 $ref: "#/components/responses/Err404" 393 description: NOT_FOUND — resource does not exist for this caller. 394 "429": 395 $ref: "#/components/responses/Err429" 396 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 397 "500": 398 $ref: "#/components/responses/Err500" 399 description: INTERNAL_ERROR — unexpected server error. 400 /auth/login: 401 post: 402 operationId: PostAuthLogin 403 tags: 404 - Auth 405 summary: Log in (email + password) 406 security: [] 407 parameters: 408 - $ref: "#/components/parameters/IdempotencyKey" 409 responses: 410 "200": 411 description: OK. 412 content: 413 application/json: 414 schema: 415 type: object 416 "400": 417 $ref: "#/components/responses/Err400" 418 description: VALIDATION_ERROR — request validation failed. 419 "429": 420 $ref: "#/components/responses/Err429" 421 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 422 "500": 423 $ref: "#/components/responses/Err500" 424 description: INTERNAL_ERROR — unexpected server error. 425 /auth/logout: 426 post: 427 operationId: PostAuthLogout 428 tags: 429 - Auth 430 summary: Log out the current session 431 security: 432 - bearerAuth: [] 433 parameters: 434 - $ref: "#/components/parameters/IdempotencyKey" 435 responses: 436 "200": 437 description: OK. 438 content: 439 application/json: 440 schema: 441 type: object 442 "400": 443 $ref: "#/components/responses/Err400" 444 description: VALIDATION_ERROR — request validation failed. 445 "401": 446 $ref: "#/components/responses/Err401" 447 description: UNAUTHORIZED — missing/invalid credentials. 448 "403": 449 $ref: "#/components/responses/Err403" 450 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 451 "404": 452 $ref: "#/components/responses/Err404" 453 description: NOT_FOUND — resource does not exist for this caller. 454 "429": 455 $ref: "#/components/responses/Err429" 456 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 457 "500": 458 $ref: "#/components/responses/Err500" 459 description: INTERNAL_ERROR — unexpected server error. 460 /auth/me: 461 get: 462 operationId: GetAuthMe 463 tags: 464 - Auth 465 summary: Get the authenticated user 466 security: 467 - bearerAuth: [] 468 parameters: [] 469 responses: 470 "200": 471 description: OK. 472 content: 473 application/json: 474 schema: 475 type: object 476 "401": 477 $ref: "#/components/responses/Err401" 478 description: UNAUTHORIZED — missing/invalid credentials. 479 "429": 480 $ref: "#/components/responses/Err429" 481 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 482 "500": 483 $ref: "#/components/responses/Err500" 484 description: INTERNAL_ERROR — unexpected server error. 485 /auth/refresh: 486 post: 487 operationId: PostAuthRefresh 488 tags: 489 - Auth 490 summary: Refresh the session tokens 491 security: [] 492 parameters: 493 - $ref: "#/components/parameters/IdempotencyKey" 494 responses: 495 "200": 496 description: OK. 497 content: 498 application/json: 499 schema: 500 type: object 501 "400": 502 $ref: "#/components/responses/Err400" 503 description: VALIDATION_ERROR — request validation failed. 504 "429": 505 $ref: "#/components/responses/Err429" 506 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 507 "500": 508 $ref: "#/components/responses/Err500" 509 description: INTERNAL_ERROR — unexpected server error. 510 /auth/register: 511 post: 512 operationId: PostAuthRegister 513 tags: 514 - Auth 515 summary: Register a new account 516 security: [] 517 parameters: 518 - $ref: "#/components/parameters/IdempotencyKey" 519 responses: 520 "201": 521 description: The created resource. 522 content: 523 application/json: 524 schema: 525 type: object 526 "400": 527 $ref: "#/components/responses/Err400" 528 description: VALIDATION_ERROR — request validation failed. 529 "409": 530 $ref: "#/components/responses/Err409" 531 description: CONFLICT — duplicate or state conflict. 532 "429": 533 $ref: "#/components/responses/Err429" 534 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 535 "500": 536 $ref: "#/components/responses/Err500" 537 description: INTERNAL_ERROR — unexpected server error. 538 /auth/reset-password: 539 post: 540 operationId: PostAuthResetPassword 541 tags: 542 - Auth 543 summary: Request a password reset 544 security: [] 545 parameters: 546 - $ref: "#/components/parameters/IdempotencyKey" 547 responses: 548 "200": 549 description: OK. 550 content: 551 application/json: 552 schema: 553 type: object 554 "400": 555 $ref: "#/components/responses/Err400" 556 description: VALIDATION_ERROR — request validation failed. 557 "429": 558 $ref: "#/components/responses/Err429" 559 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 560 "500": 561 $ref: "#/components/responses/Err500" 562 description: INTERNAL_ERROR — unexpected server error. 563 /auth/reset-password/confirm: 564 post: 565 operationId: PostAuthResetPasswordConfirm 566 tags: 567 - Auth 568 summary: Confirm a password reset 569 security: [] 570 parameters: 571 - $ref: "#/components/parameters/IdempotencyKey" 572 responses: 573 "200": 574 description: OK. 575 content: 576 application/json: 577 schema: 578 type: object 579 "400": 580 $ref: "#/components/responses/Err400" 581 description: VALIDATION_ERROR — request validation failed. 582 "429": 583 $ref: "#/components/responses/Err429" 584 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 585 "500": 586 $ref: "#/components/responses/Err500" 587 description: INTERNAL_ERROR — unexpected server error. 588 /auth/sso/options: 589 get: 590 operationId: GetAuthSsoOptions 591 tags: 592 - Auth 593 summary: "SSO discovery for the login page (anonymous, minimal-info: org slugs with SSO enabled)" 594 security: [] 595 parameters: [] 596 responses: 597 "200": 598 description: OK. 599 content: 600 application/json: 601 schema: 602 type: object 603 "429": 604 $ref: "#/components/responses/Err429" 605 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 606 "500": 607 $ref: "#/components/responses/Err500" 608 description: INTERNAL_ERROR — unexpected server error. 609 /automations/{id}: 610 get: 611 operationId: GetAutomationsById 612 tags: 613 - Automations 614 summary: Get automations by id 615 security: 616 - bearerAuth: [] 617 parameters: 618 - name: id 619 in: path 620 required: true 621 schema: 622 type: string 623 responses: 624 "200": 625 description: OK. 626 content: 627 application/json: 628 schema: 629 type: object 630 "401": 631 $ref: "#/components/responses/Err401" 632 description: UNAUTHORIZED — missing/invalid credentials. 633 "403": 634 $ref: "#/components/responses/Err403" 635 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 636 "404": 637 $ref: "#/components/responses/Err404" 638 description: NOT_FOUND — resource does not exist for this caller. 639 "429": 640 $ref: "#/components/responses/Err429" 641 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 642 "500": 643 $ref: "#/components/responses/Err500" 644 description: INTERNAL_ERROR — unexpected server error. 645 patch: 646 operationId: PatchAutomationsById 647 tags: 648 - Automations 649 summary: Update automations by id 650 security: 651 - bearerAuth: [] 652 parameters: 653 - name: id 654 in: path 655 required: true 656 schema: 657 type: string 658 - $ref: "#/components/parameters/IdempotencyKey" 659 responses: 660 "200": 661 description: OK. 662 content: 663 application/json: 664 schema: 665 type: object 666 "400": 667 $ref: "#/components/responses/Err400" 668 description: VALIDATION_ERROR — request validation failed. 669 "401": 670 $ref: "#/components/responses/Err401" 671 description: UNAUTHORIZED — missing/invalid credentials. 672 "403": 673 $ref: "#/components/responses/Err403" 674 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 675 "404": 676 $ref: "#/components/responses/Err404" 677 description: NOT_FOUND — resource does not exist for this caller. 678 "409": 679 $ref: "#/components/responses/Err409" 680 description: CONFLICT — duplicate or state conflict. 681 "429": 682 $ref: "#/components/responses/Err429" 683 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 684 "500": 685 $ref: "#/components/responses/Err500" 686 description: INTERNAL_ERROR — unexpected server error. 687 delete: 688 operationId: DeleteAutomationsById 689 tags: 690 - Automations 691 summary: Delete automations by id 692 security: 693 - bearerAuth: [] 694 parameters: 695 - name: id 696 in: path 697 required: true 698 schema: 699 type: string 700 - $ref: "#/components/parameters/IdempotencyKey" 701 responses: 702 "200": 703 description: OK. 704 content: 705 application/json: 706 schema: 707 type: object 708 "400": 709 $ref: "#/components/responses/Err400" 710 description: VALIDATION_ERROR — request validation failed. 711 "401": 712 $ref: "#/components/responses/Err401" 713 description: UNAUTHORIZED — missing/invalid credentials. 714 "403": 715 $ref: "#/components/responses/Err403" 716 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 717 "404": 718 $ref: "#/components/responses/Err404" 719 description: NOT_FOUND — resource does not exist for this caller. 720 "429": 721 $ref: "#/components/responses/Err429" 722 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 723 "500": 724 $ref: "#/components/responses/Err500" 725 description: INTERNAL_ERROR — unexpected server error. 726 /automations/{id}/actions: 727 put: 728 operationId: PutAutomationsByIdActions 729 tags: 730 - Automations 731 summary: Replace automations by id 732 security: 733 - bearerAuth: [] 734 parameters: 735 - name: id 736 in: path 737 required: true 738 schema: 739 type: string 740 - $ref: "#/components/parameters/IdempotencyKey" 741 responses: 742 "200": 743 description: OK. 744 content: 745 application/json: 746 schema: 747 type: object 748 "400": 749 $ref: "#/components/responses/Err400" 750 description: VALIDATION_ERROR — request validation failed. 751 "401": 752 $ref: "#/components/responses/Err401" 753 description: UNAUTHORIZED — missing/invalid credentials. 754 "403": 755 $ref: "#/components/responses/Err403" 756 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 757 "404": 758 $ref: "#/components/responses/Err404" 759 description: NOT_FOUND — resource does not exist for this caller. 760 "409": 761 $ref: "#/components/responses/Err409" 762 description: CONFLICT — duplicate or state conflict. 763 "429": 764 $ref: "#/components/responses/Err429" 765 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 766 "500": 767 $ref: "#/components/responses/Err500" 768 description: INTERNAL_ERROR — unexpected server error. 769 /automations/{id}/conditions: 770 put: 771 operationId: PutAutomationsByIdConditions 772 tags: 773 - Automations 774 summary: Replace automations by id 775 security: 776 - bearerAuth: [] 777 parameters: 778 - name: id 779 in: path 780 required: true 781 schema: 782 type: string 783 - $ref: "#/components/parameters/IdempotencyKey" 784 responses: 785 "200": 786 description: OK. 787 content: 788 application/json: 789 schema: 790 type: object 791 "400": 792 $ref: "#/components/responses/Err400" 793 description: VALIDATION_ERROR — request validation failed. 794 "401": 795 $ref: "#/components/responses/Err401" 796 description: UNAUTHORIZED — missing/invalid credentials. 797 "403": 798 $ref: "#/components/responses/Err403" 799 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 800 "404": 801 $ref: "#/components/responses/Err404" 802 description: NOT_FOUND — resource does not exist for this caller. 803 "409": 804 $ref: "#/components/responses/Err409" 805 description: CONFLICT — duplicate or state conflict. 806 "429": 807 $ref: "#/components/responses/Err429" 808 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 809 "500": 810 $ref: "#/components/responses/Err500" 811 description: INTERNAL_ERROR — unexpected server error. 812 /automations/{id}/run: 813 post: 814 operationId: PostAutomationsByIdRun 815 tags: 816 - Automations 817 summary: Create automations by id 818 security: 819 - bearerAuth: [] 820 parameters: 821 - name: id 822 in: path 823 required: true 824 schema: 825 type: string 826 - $ref: "#/components/parameters/IdempotencyKey" 827 responses: 828 "200": 829 description: OK. 830 content: 831 application/json: 832 schema: 833 type: object 834 "400": 835 $ref: "#/components/responses/Err400" 836 description: VALIDATION_ERROR — request validation failed. 837 "401": 838 $ref: "#/components/responses/Err401" 839 description: UNAUTHORIZED — missing/invalid credentials. 840 "403": 841 $ref: "#/components/responses/Err403" 842 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 843 "404": 844 $ref: "#/components/responses/Err404" 845 description: NOT_FOUND — resource does not exist for this caller. 846 "429": 847 $ref: "#/components/responses/Err429" 848 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 849 "500": 850 $ref: "#/components/responses/Err500" 851 description: INTERNAL_ERROR — unexpected server error. 852 /automations/{id}/runs: 853 get: 854 operationId: GetAutomationsByIdRuns 855 tags: 856 - Automations 857 summary: Get automations by id 858 security: 859 - bearerAuth: [] 860 parameters: 861 - name: id 862 in: path 863 required: true 864 schema: 865 type: string 866 responses: 867 "200": 868 description: OK. 869 content: 870 application/json: 871 schema: 872 type: object 873 "401": 874 $ref: "#/components/responses/Err401" 875 description: UNAUTHORIZED — missing/invalid credentials. 876 "403": 877 $ref: "#/components/responses/Err403" 878 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 879 "404": 880 $ref: "#/components/responses/Err404" 881 description: NOT_FOUND — resource does not exist for this caller. 882 "429": 883 $ref: "#/components/responses/Err429" 884 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 885 "500": 886 $ref: "#/components/responses/Err500" 887 description: INTERNAL_ERROR — unexpected server error. 888 /automations/{id}/runs/{runId}: 889 get: 890 operationId: GetAutomationsByIdRunsByRunId 891 tags: 892 - Automations 893 summary: Get automations by id + runId 894 security: 895 - bearerAuth: [] 896 parameters: 897 - name: id 898 in: path 899 required: true 900 schema: 901 type: string 902 - name: runId 903 in: path 904 required: true 905 schema: 906 type: string 907 responses: 908 "200": 909 description: OK. 910 content: 911 application/json: 912 schema: 913 type: object 914 "401": 915 $ref: "#/components/responses/Err401" 916 description: UNAUTHORIZED — missing/invalid credentials. 917 "403": 918 $ref: "#/components/responses/Err403" 919 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 920 "404": 921 $ref: "#/components/responses/Err404" 922 description: NOT_FOUND — resource does not exist for this caller. 923 "429": 924 $ref: "#/components/responses/Err429" 925 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 926 "500": 927 $ref: "#/components/responses/Err500" 928 description: INTERNAL_ERROR — unexpected server error. 929 /automations/{id}/runs/{runId}/retry: 930 post: 931 operationId: PostAutomationsByIdRunsByRunIdRetry 932 tags: 933 - Automations 934 summary: Create automations by id + runId 935 security: 936 - bearerAuth: [] 937 parameters: 938 - name: id 939 in: path 940 required: true 941 schema: 942 type: string 943 - name: runId 944 in: path 945 required: true 946 schema: 947 type: string 948 - $ref: "#/components/parameters/IdempotencyKey" 949 responses: 950 "200": 951 description: OK. 952 content: 953 application/json: 954 schema: 955 type: object 956 "400": 957 $ref: "#/components/responses/Err400" 958 description: VALIDATION_ERROR — request validation failed. 959 "401": 960 $ref: "#/components/responses/Err401" 961 description: UNAUTHORIZED — missing/invalid credentials. 962 "403": 963 $ref: "#/components/responses/Err403" 964 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 965 "404": 966 $ref: "#/components/responses/Err404" 967 description: NOT_FOUND — resource does not exist for this caller. 968 "429": 969 $ref: "#/components/responses/Err429" 970 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 971 "500": 972 $ref: "#/components/responses/Err500" 973 description: INTERNAL_ERROR — unexpected server error. 974 /automations/{id}/status: 975 post: 976 operationId: PostAutomationsByIdStatus 977 tags: 978 - Automations 979 summary: Create automations by id 980 security: 981 - bearerAuth: [] 982 parameters: 983 - name: id 984 in: path 985 required: true 986 schema: 987 type: string 988 - $ref: "#/components/parameters/IdempotencyKey" 989 responses: 990 "200": 991 description: OK. 992 content: 993 application/json: 994 schema: 995 type: object 996 "400": 997 $ref: "#/components/responses/Err400" 998 description: VALIDATION_ERROR — request validation failed. 999 "401": 1000 $ref: "#/components/responses/Err401" 1001 description: UNAUTHORIZED — missing/invalid credentials. 1002 "403": 1003 $ref: "#/components/responses/Err403" 1004 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1005 "404": 1006 $ref: "#/components/responses/Err404" 1007 description: NOT_FOUND — resource does not exist for this caller. 1008 "429": 1009 $ref: "#/components/responses/Err429" 1010 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1011 "500": 1012 $ref: "#/components/responses/Err500" 1013 description: INTERNAL_ERROR — unexpected server error. 1014 /automations/{id}/triggers: 1015 put: 1016 operationId: PutAutomationsByIdTriggers 1017 tags: 1018 - Automations 1019 summary: Replace automations by id 1020 security: 1021 - bearerAuth: [] 1022 parameters: 1023 - name: id 1024 in: path 1025 required: true 1026 schema: 1027 type: string 1028 - $ref: "#/components/parameters/IdempotencyKey" 1029 responses: 1030 "200": 1031 description: OK. 1032 content: 1033 application/json: 1034 schema: 1035 type: object 1036 "400": 1037 $ref: "#/components/responses/Err400" 1038 description: VALIDATION_ERROR — request validation failed. 1039 "401": 1040 $ref: "#/components/responses/Err401" 1041 description: UNAUTHORIZED — missing/invalid credentials. 1042 "403": 1043 $ref: "#/components/responses/Err403" 1044 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1045 "404": 1046 $ref: "#/components/responses/Err404" 1047 description: NOT_FOUND — resource does not exist for this caller. 1048 "409": 1049 $ref: "#/components/responses/Err409" 1050 description: CONFLICT — duplicate or state conflict. 1051 "429": 1052 $ref: "#/components/responses/Err429" 1053 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1054 "500": 1055 $ref: "#/components/responses/Err500" 1056 description: INTERNAL_ERROR — unexpected server error. 1057 /automations/{id}/webhook/regenerate: 1058 post: 1059 operationId: PostAutomationsByIdWebhookRegenerate 1060 tags: 1061 - Automations 1062 summary: Create automations by id 1063 security: 1064 - bearerAuth: [] 1065 parameters: 1066 - name: id 1067 in: path 1068 required: true 1069 schema: 1070 type: string 1071 - $ref: "#/components/parameters/IdempotencyKey" 1072 responses: 1073 "200": 1074 description: OK. 1075 content: 1076 application/json: 1077 schema: 1078 type: object 1079 "400": 1080 $ref: "#/components/responses/Err400" 1081 description: VALIDATION_ERROR — request validation failed. 1082 "401": 1083 $ref: "#/components/responses/Err401" 1084 description: UNAUTHORIZED — missing/invalid credentials. 1085 "403": 1086 $ref: "#/components/responses/Err403" 1087 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1088 "404": 1089 $ref: "#/components/responses/Err404" 1090 description: NOT_FOUND — resource does not exist for this caller. 1091 "429": 1092 $ref: "#/components/responses/Err429" 1093 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1094 "500": 1095 $ref: "#/components/responses/Err500" 1096 description: INTERNAL_ERROR — unexpected server error. 1097 /blocks/{id}: 1098 patch: 1099 operationId: PatchBlocksById 1100 tags: 1101 - Blocks 1102 summary: Update blocks by id 1103 security: 1104 - bearerAuth: [] 1105 parameters: 1106 - name: id 1107 in: path 1108 required: true 1109 schema: 1110 type: string 1111 - $ref: "#/components/parameters/IdempotencyKey" 1112 responses: 1113 "200": 1114 description: OK. 1115 content: 1116 application/json: 1117 schema: 1118 type: object 1119 "400": 1120 $ref: "#/components/responses/Err400" 1121 description: VALIDATION_ERROR — request validation failed. 1122 "401": 1123 $ref: "#/components/responses/Err401" 1124 description: UNAUTHORIZED — missing/invalid credentials. 1125 "403": 1126 $ref: "#/components/responses/Err403" 1127 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1128 "404": 1129 $ref: "#/components/responses/Err404" 1130 description: NOT_FOUND — resource does not exist for this caller. 1131 "409": 1132 $ref: "#/components/responses/Err409" 1133 description: CONFLICT — duplicate or state conflict. 1134 "429": 1135 $ref: "#/components/responses/Err429" 1136 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1137 "500": 1138 $ref: "#/components/responses/Err500" 1139 description: INTERNAL_ERROR — unexpected server error. 1140 delete: 1141 operationId: DeleteBlocksById 1142 tags: 1143 - Blocks 1144 summary: Delete blocks by id 1145 security: 1146 - bearerAuth: [] 1147 parameters: 1148 - name: id 1149 in: path 1150 required: true 1151 schema: 1152 type: string 1153 - $ref: "#/components/parameters/IdempotencyKey" 1154 responses: 1155 "200": 1156 description: OK. 1157 content: 1158 application/json: 1159 schema: 1160 type: object 1161 "400": 1162 $ref: "#/components/responses/Err400" 1163 description: VALIDATION_ERROR — request validation failed. 1164 "401": 1165 $ref: "#/components/responses/Err401" 1166 description: UNAUTHORIZED — missing/invalid credentials. 1167 "403": 1168 $ref: "#/components/responses/Err403" 1169 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1170 "404": 1171 $ref: "#/components/responses/Err404" 1172 description: NOT_FOUND — resource does not exist for this caller. 1173 "429": 1174 $ref: "#/components/responses/Err429" 1175 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1176 "500": 1177 $ref: "#/components/responses/Err500" 1178 description: INTERNAL_ERROR — unexpected server error. 1179 /blocks/{id}/duplicate: 1180 post: 1181 operationId: PostBlocksByIdDuplicate 1182 tags: 1183 - Blocks 1184 summary: Create blocks by id 1185 security: 1186 - bearerAuth: [] 1187 parameters: 1188 - name: id 1189 in: path 1190 required: true 1191 schema: 1192 type: string 1193 - $ref: "#/components/parameters/IdempotencyKey" 1194 responses: 1195 "200": 1196 description: OK. 1197 content: 1198 application/json: 1199 schema: 1200 type: object 1201 "400": 1202 $ref: "#/components/responses/Err400" 1203 description: VALIDATION_ERROR — request validation failed. 1204 "401": 1205 $ref: "#/components/responses/Err401" 1206 description: UNAUTHORIZED — missing/invalid credentials. 1207 "403": 1208 $ref: "#/components/responses/Err403" 1209 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1210 "404": 1211 $ref: "#/components/responses/Err404" 1212 description: NOT_FOUND — resource does not exist for this caller. 1213 "429": 1214 $ref: "#/components/responses/Err429" 1215 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1216 "500": 1217 $ref: "#/components/responses/Err500" 1218 description: INTERNAL_ERROR — unexpected server error. 1219 /blocks/{id}/move: 1220 post: 1221 operationId: PostBlocksByIdMove 1222 tags: 1223 - Blocks 1224 summary: Create blocks by id 1225 security: 1226 - bearerAuth: [] 1227 parameters: 1228 - name: id 1229 in: path 1230 required: true 1231 schema: 1232 type: string 1233 - $ref: "#/components/parameters/IdempotencyKey" 1234 responses: 1235 "200": 1236 description: OK. 1237 content: 1238 application/json: 1239 schema: 1240 type: object 1241 "400": 1242 $ref: "#/components/responses/Err400" 1243 description: VALIDATION_ERROR — request validation failed. 1244 "401": 1245 $ref: "#/components/responses/Err401" 1246 description: UNAUTHORIZED — missing/invalid credentials. 1247 "403": 1248 $ref: "#/components/responses/Err403" 1249 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1250 "404": 1251 $ref: "#/components/responses/Err404" 1252 description: NOT_FOUND — resource does not exist for this caller. 1253 "429": 1254 $ref: "#/components/responses/Err429" 1255 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1256 "500": 1257 $ref: "#/components/responses/Err500" 1258 description: INTERNAL_ERROR — unexpected server error. 1259 /blocks/batch: 1260 post: 1261 operationId: PostBlocksBatch 1262 tags: 1263 - Blocks 1264 summary: Batch block operation 1265 security: 1266 - bearerAuth: [] 1267 parameters: 1268 - $ref: "#/components/parameters/IdempotencyKey" 1269 responses: 1270 "201": 1271 description: The created resource. 1272 content: 1273 application/json: 1274 schema: 1275 type: object 1276 "400": 1277 $ref: "#/components/responses/Err400" 1278 description: VALIDATION_ERROR — request validation failed. 1279 "401": 1280 $ref: "#/components/responses/Err401" 1281 description: UNAUTHORIZED — missing/invalid credentials. 1282 "403": 1283 $ref: "#/components/responses/Err403" 1284 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1285 "404": 1286 $ref: "#/components/responses/Err404" 1287 description: NOT_FOUND — resource does not exist for this caller. 1288 "409": 1289 $ref: "#/components/responses/Err409" 1290 description: CONFLICT — duplicate or state conflict. 1291 "429": 1292 $ref: "#/components/responses/Err429" 1293 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1294 "500": 1295 $ref: "#/components/responses/Err500" 1296 description: INTERNAL_ERROR — unexpected server error. 1297 /comments: 1298 get: 1299 operationId: GetComments 1300 tags: 1301 - Comments 1302 summary: List comments 1303 security: 1304 - bearerAuth: [] 1305 parameters: [] 1306 responses: 1307 "200": 1308 description: OK. 1309 content: 1310 application/json: 1311 schema: 1312 type: object 1313 "401": 1314 $ref: "#/components/responses/Err401" 1315 description: UNAUTHORIZED — missing/invalid credentials. 1316 "403": 1317 $ref: "#/components/responses/Err403" 1318 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1319 "404": 1320 $ref: "#/components/responses/Err404" 1321 description: NOT_FOUND — resource does not exist for this caller. 1322 "429": 1323 $ref: "#/components/responses/Err429" 1324 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1325 "500": 1326 $ref: "#/components/responses/Err500" 1327 description: INTERNAL_ERROR — unexpected server error. 1328 post: 1329 operationId: PostComments 1330 tags: 1331 - Comments 1332 summary: Create comments 1333 security: 1334 - bearerAuth: [] 1335 parameters: 1336 - $ref: "#/components/parameters/IdempotencyKey" 1337 responses: 1338 "201": 1339 description: The created resource. 1340 content: 1341 application/json: 1342 schema: 1343 type: object 1344 "400": 1345 $ref: "#/components/responses/Err400" 1346 description: VALIDATION_ERROR — request validation failed. 1347 "401": 1348 $ref: "#/components/responses/Err401" 1349 description: UNAUTHORIZED — missing/invalid credentials. 1350 "403": 1351 $ref: "#/components/responses/Err403" 1352 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1353 "404": 1354 $ref: "#/components/responses/Err404" 1355 description: NOT_FOUND — resource does not exist for this caller. 1356 "409": 1357 $ref: "#/components/responses/Err409" 1358 description: CONFLICT — duplicate or state conflict. 1359 "429": 1360 $ref: "#/components/responses/Err429" 1361 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1362 "500": 1363 $ref: "#/components/responses/Err500" 1364 description: INTERNAL_ERROR — unexpected server error. 1365 /comments/{id}: 1366 patch: 1367 operationId: PatchCommentsById 1368 tags: 1369 - Comments 1370 summary: Update comments by id 1371 security: 1372 - bearerAuth: [] 1373 parameters: 1374 - name: id 1375 in: path 1376 required: true 1377 schema: 1378 type: string 1379 - $ref: "#/components/parameters/IdempotencyKey" 1380 responses: 1381 "200": 1382 description: OK. 1383 content: 1384 application/json: 1385 schema: 1386 type: object 1387 "400": 1388 $ref: "#/components/responses/Err400" 1389 description: VALIDATION_ERROR — request validation failed. 1390 "401": 1391 $ref: "#/components/responses/Err401" 1392 description: UNAUTHORIZED — missing/invalid credentials. 1393 "403": 1394 $ref: "#/components/responses/Err403" 1395 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1396 "404": 1397 $ref: "#/components/responses/Err404" 1398 description: NOT_FOUND — resource does not exist for this caller. 1399 "409": 1400 $ref: "#/components/responses/Err409" 1401 description: CONFLICT — duplicate or state conflict. 1402 "429": 1403 $ref: "#/components/responses/Err429" 1404 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1405 "500": 1406 $ref: "#/components/responses/Err500" 1407 description: INTERNAL_ERROR — unexpected server error. 1408 delete: 1409 operationId: DeleteCommentsById 1410 tags: 1411 - Comments 1412 summary: Delete comments by id 1413 security: 1414 - bearerAuth: [] 1415 parameters: 1416 - name: id 1417 in: path 1418 required: true 1419 schema: 1420 type: string 1421 - $ref: "#/components/parameters/IdempotencyKey" 1422 responses: 1423 "200": 1424 description: OK. 1425 content: 1426 application/json: 1427 schema: 1428 type: object 1429 "400": 1430 $ref: "#/components/responses/Err400" 1431 description: VALIDATION_ERROR — request validation failed. 1432 "401": 1433 $ref: "#/components/responses/Err401" 1434 description: UNAUTHORIZED — missing/invalid credentials. 1435 "403": 1436 $ref: "#/components/responses/Err403" 1437 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1438 "404": 1439 $ref: "#/components/responses/Err404" 1440 description: NOT_FOUND — resource does not exist for this caller. 1441 "429": 1442 $ref: "#/components/responses/Err429" 1443 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1444 "500": 1445 $ref: "#/components/responses/Err500" 1446 description: INTERNAL_ERROR — unexpected server error. 1447 /comments/{id}/reactions: 1448 post: 1449 operationId: PostCommentsByIdReactions 1450 tags: 1451 - Comments 1452 summary: Create comments by id 1453 security: 1454 - bearerAuth: [] 1455 parameters: 1456 - name: id 1457 in: path 1458 required: true 1459 schema: 1460 type: string 1461 - $ref: "#/components/parameters/IdempotencyKey" 1462 responses: 1463 "200": 1464 description: OK. 1465 content: 1466 application/json: 1467 schema: 1468 type: object 1469 "400": 1470 $ref: "#/components/responses/Err400" 1471 description: VALIDATION_ERROR — request validation failed. 1472 "401": 1473 $ref: "#/components/responses/Err401" 1474 description: UNAUTHORIZED — missing/invalid credentials. 1475 "403": 1476 $ref: "#/components/responses/Err403" 1477 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1478 "404": 1479 $ref: "#/components/responses/Err404" 1480 description: NOT_FOUND — resource does not exist for this caller. 1481 "429": 1482 $ref: "#/components/responses/Err429" 1483 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1484 "500": 1485 $ref: "#/components/responses/Err500" 1486 description: INTERNAL_ERROR — unexpected server error. 1487 /comments/{id}/reopen: 1488 post: 1489 operationId: PostCommentsByIdReopen 1490 tags: 1491 - Comments 1492 summary: Create comments by id 1493 security: 1494 - bearerAuth: [] 1495 parameters: 1496 - name: id 1497 in: path 1498 required: true 1499 schema: 1500 type: string 1501 - $ref: "#/components/parameters/IdempotencyKey" 1502 responses: 1503 "200": 1504 description: OK. 1505 content: 1506 application/json: 1507 schema: 1508 type: object 1509 "400": 1510 $ref: "#/components/responses/Err400" 1511 description: VALIDATION_ERROR — request validation failed. 1512 "401": 1513 $ref: "#/components/responses/Err401" 1514 description: UNAUTHORIZED — missing/invalid credentials. 1515 "403": 1516 $ref: "#/components/responses/Err403" 1517 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1518 "404": 1519 $ref: "#/components/responses/Err404" 1520 description: NOT_FOUND — resource does not exist for this caller. 1521 "429": 1522 $ref: "#/components/responses/Err429" 1523 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1524 "500": 1525 $ref: "#/components/responses/Err500" 1526 description: INTERNAL_ERROR — unexpected server error. 1527 /comments/{id}/resolve: 1528 post: 1529 operationId: PostCommentsByIdResolve 1530 tags: 1531 - Comments 1532 summary: Create comments by id 1533 security: 1534 - bearerAuth: [] 1535 parameters: 1536 - name: id 1537 in: path 1538 required: true 1539 schema: 1540 type: string 1541 - $ref: "#/components/parameters/IdempotencyKey" 1542 responses: 1543 "200": 1544 description: OK. 1545 content: 1546 application/json: 1547 schema: 1548 type: object 1549 "400": 1550 $ref: "#/components/responses/Err400" 1551 description: VALIDATION_ERROR — request validation failed. 1552 "401": 1553 $ref: "#/components/responses/Err401" 1554 description: UNAUTHORIZED — missing/invalid credentials. 1555 "403": 1556 $ref: "#/components/responses/Err403" 1557 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1558 "404": 1559 $ref: "#/components/responses/Err404" 1560 description: NOT_FOUND — resource does not exist for this caller. 1561 "429": 1562 $ref: "#/components/responses/Err429" 1563 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1564 "500": 1565 $ref: "#/components/responses/Err500" 1566 description: INTERNAL_ERROR — unexpected server error. 1567 /databases/{databaseId}/forms: 1568 get: 1569 operationId: GetDatabasesByDatabaseIdForms 1570 tags: 1571 - Databases 1572 summary: Get databases by databaseId 1573 security: 1574 - bearerAuth: [] 1575 parameters: 1576 - name: databaseId 1577 in: path 1578 required: true 1579 schema: 1580 type: string 1581 responses: 1582 "200": 1583 description: OK. 1584 content: 1585 application/json: 1586 schema: 1587 type: object 1588 "401": 1589 $ref: "#/components/responses/Err401" 1590 description: UNAUTHORIZED — missing/invalid credentials. 1591 "403": 1592 $ref: "#/components/responses/Err403" 1593 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1594 "404": 1595 $ref: "#/components/responses/Err404" 1596 description: NOT_FOUND — resource does not exist for this caller. 1597 "429": 1598 $ref: "#/components/responses/Err429" 1599 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1600 "500": 1601 $ref: "#/components/responses/Err500" 1602 description: INTERNAL_ERROR — unexpected server error. 1603 post: 1604 operationId: PostDatabasesByDatabaseIdForms 1605 tags: 1606 - Databases 1607 summary: Create databases by databaseId 1608 security: 1609 - bearerAuth: [] 1610 parameters: 1611 - name: databaseId 1612 in: path 1613 required: true 1614 schema: 1615 type: string 1616 - $ref: "#/components/parameters/IdempotencyKey" 1617 responses: 1618 "201": 1619 description: The created resource. 1620 content: 1621 application/json: 1622 schema: 1623 type: object 1624 "400": 1625 $ref: "#/components/responses/Err400" 1626 description: VALIDATION_ERROR — request validation failed. 1627 "401": 1628 $ref: "#/components/responses/Err401" 1629 description: UNAUTHORIZED — missing/invalid credentials. 1630 "403": 1631 $ref: "#/components/responses/Err403" 1632 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1633 "404": 1634 $ref: "#/components/responses/Err404" 1635 description: NOT_FOUND — resource does not exist for this caller. 1636 "409": 1637 $ref: "#/components/responses/Err409" 1638 description: CONFLICT — duplicate or state conflict. 1639 "429": 1640 $ref: "#/components/responses/Err429" 1641 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1642 "500": 1643 $ref: "#/components/responses/Err500" 1644 description: INTERNAL_ERROR — unexpected server error. 1645 /databases/{id}: 1646 get: 1647 operationId: GetDatabasesById 1648 tags: 1649 - Databases 1650 summary: Get databases by id 1651 security: 1652 - bearerAuth: [] 1653 parameters: 1654 - name: id 1655 in: path 1656 required: true 1657 schema: 1658 type: string 1659 responses: 1660 "200": 1661 description: OK. 1662 content: 1663 application/json: 1664 schema: 1665 type: object 1666 "401": 1667 $ref: "#/components/responses/Err401" 1668 description: UNAUTHORIZED — missing/invalid credentials. 1669 "403": 1670 $ref: "#/components/responses/Err403" 1671 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1672 "404": 1673 $ref: "#/components/responses/Err404" 1674 description: NOT_FOUND — resource does not exist for this caller. 1675 "429": 1676 $ref: "#/components/responses/Err429" 1677 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1678 "500": 1679 $ref: "#/components/responses/Err500" 1680 description: INTERNAL_ERROR — unexpected server error. 1681 patch: 1682 operationId: PatchDatabasesById 1683 tags: 1684 - Databases 1685 summary: Update databases by id 1686 security: 1687 - bearerAuth: [] 1688 parameters: 1689 - name: id 1690 in: path 1691 required: true 1692 schema: 1693 type: string 1694 - $ref: "#/components/parameters/IdempotencyKey" 1695 responses: 1696 "200": 1697 description: OK. 1698 content: 1699 application/json: 1700 schema: 1701 type: object 1702 "400": 1703 $ref: "#/components/responses/Err400" 1704 description: VALIDATION_ERROR — request validation failed. 1705 "401": 1706 $ref: "#/components/responses/Err401" 1707 description: UNAUTHORIZED — missing/invalid credentials. 1708 "403": 1709 $ref: "#/components/responses/Err403" 1710 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1711 "404": 1712 $ref: "#/components/responses/Err404" 1713 description: NOT_FOUND — resource does not exist for this caller. 1714 "409": 1715 $ref: "#/components/responses/Err409" 1716 description: CONFLICT — duplicate or state conflict. 1717 "429": 1718 $ref: "#/components/responses/Err429" 1719 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1720 "500": 1721 $ref: "#/components/responses/Err500" 1722 description: INTERNAL_ERROR — unexpected server error. 1723 delete: 1724 operationId: DeleteDatabasesById 1725 tags: 1726 - Databases 1727 summary: Delete databases by id 1728 security: 1729 - bearerAuth: [] 1730 parameters: 1731 - name: id 1732 in: path 1733 required: true 1734 schema: 1735 type: string 1736 - $ref: "#/components/parameters/IdempotencyKey" 1737 responses: 1738 "200": 1739 description: OK. 1740 content: 1741 application/json: 1742 schema: 1743 type: object 1744 "400": 1745 $ref: "#/components/responses/Err400" 1746 description: VALIDATION_ERROR — request validation failed. 1747 "401": 1748 $ref: "#/components/responses/Err401" 1749 description: UNAUTHORIZED — missing/invalid credentials. 1750 "403": 1751 $ref: "#/components/responses/Err403" 1752 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1753 "404": 1754 $ref: "#/components/responses/Err404" 1755 description: NOT_FOUND — resource does not exist for this caller. 1756 "429": 1757 $ref: "#/components/responses/Err429" 1758 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1759 "500": 1760 $ref: "#/components/responses/Err500" 1761 description: INTERNAL_ERROR — unexpected server error. 1762 /databases/{id}/export: 1763 get: 1764 operationId: GetDatabasesByIdExport 1765 tags: 1766 - Databases 1767 summary: Get databases by id 1768 security: 1769 - bearerAuth: [] 1770 parameters: 1771 - name: id 1772 in: path 1773 required: true 1774 schema: 1775 type: string 1776 responses: 1777 "200": 1778 description: OK. 1779 content: 1780 application/json: 1781 schema: 1782 type: object 1783 "401": 1784 $ref: "#/components/responses/Err401" 1785 description: UNAUTHORIZED — missing/invalid credentials. 1786 "403": 1787 $ref: "#/components/responses/Err403" 1788 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1789 "404": 1790 $ref: "#/components/responses/Err404" 1791 description: NOT_FOUND — resource does not exist for this caller. 1792 "429": 1793 $ref: "#/components/responses/Err429" 1794 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1795 "500": 1796 $ref: "#/components/responses/Err500" 1797 description: INTERNAL_ERROR — unexpected server error. 1798 /databases/{id}/formulas: 1799 get: 1800 operationId: GetDatabasesByIdFormulas 1801 tags: 1802 - Databases 1803 summary: Get databases by id 1804 security: 1805 - bearerAuth: [] 1806 parameters: 1807 - name: id 1808 in: path 1809 required: true 1810 schema: 1811 type: string 1812 responses: 1813 "200": 1814 description: OK. 1815 content: 1816 application/json: 1817 schema: 1818 type: object 1819 "401": 1820 $ref: "#/components/responses/Err401" 1821 description: UNAUTHORIZED — missing/invalid credentials. 1822 "403": 1823 $ref: "#/components/responses/Err403" 1824 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1825 "404": 1826 $ref: "#/components/responses/Err404" 1827 description: NOT_FOUND — resource does not exist for this caller. 1828 "429": 1829 $ref: "#/components/responses/Err429" 1830 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1831 "500": 1832 $ref: "#/components/responses/Err500" 1833 description: INTERNAL_ERROR — unexpected server error. 1834 post: 1835 operationId: PostDatabasesByIdFormulas 1836 tags: 1837 - Databases 1838 summary: Create databases by id 1839 security: 1840 - bearerAuth: [] 1841 parameters: 1842 - name: id 1843 in: path 1844 required: true 1845 schema: 1846 type: string 1847 - $ref: "#/components/parameters/IdempotencyKey" 1848 responses: 1849 "201": 1850 description: The created resource. 1851 content: 1852 application/json: 1853 schema: 1854 type: object 1855 "400": 1856 $ref: "#/components/responses/Err400" 1857 description: VALIDATION_ERROR — request validation failed. 1858 "401": 1859 $ref: "#/components/responses/Err401" 1860 description: UNAUTHORIZED — missing/invalid credentials. 1861 "403": 1862 $ref: "#/components/responses/Err403" 1863 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1864 "404": 1865 $ref: "#/components/responses/Err404" 1866 description: NOT_FOUND — resource does not exist for this caller. 1867 "409": 1868 $ref: "#/components/responses/Err409" 1869 description: CONFLICT — duplicate or state conflict. 1870 "429": 1871 $ref: "#/components/responses/Err429" 1872 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1873 "500": 1874 $ref: "#/components/responses/Err500" 1875 description: INTERNAL_ERROR — unexpected server error. 1876 /databases/{id}/formulas/validate: 1877 post: 1878 operationId: PostDatabasesByIdFormulasValidate 1879 tags: 1880 - Databases 1881 summary: Create databases by id 1882 security: 1883 - bearerAuth: [] 1884 parameters: 1885 - name: id 1886 in: path 1887 required: true 1888 schema: 1889 type: string 1890 - $ref: "#/components/parameters/IdempotencyKey" 1891 responses: 1892 "200": 1893 description: OK. 1894 content: 1895 application/json: 1896 schema: 1897 type: object 1898 "400": 1899 $ref: "#/components/responses/Err400" 1900 description: VALIDATION_ERROR — request validation failed. 1901 "401": 1902 $ref: "#/components/responses/Err401" 1903 description: UNAUTHORIZED — missing/invalid credentials. 1904 "403": 1905 $ref: "#/components/responses/Err403" 1906 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1907 "404": 1908 $ref: "#/components/responses/Err404" 1909 description: NOT_FOUND — resource does not exist for this caller. 1910 "429": 1911 $ref: "#/components/responses/Err429" 1912 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1913 "500": 1914 $ref: "#/components/responses/Err500" 1915 description: INTERNAL_ERROR — unexpected server error. 1916 /databases/{id}/import/csv: 1917 post: 1918 operationId: PostDatabasesByIdImportCsv 1919 tags: 1920 - Databases 1921 summary: Create databases by id 1922 security: 1923 - bearerAuth: [] 1924 parameters: 1925 - name: id 1926 in: path 1927 required: true 1928 schema: 1929 type: string 1930 - $ref: "#/components/parameters/IdempotencyKey" 1931 responses: 1932 "200": 1933 description: OK. 1934 content: 1935 application/json: 1936 schema: 1937 type: object 1938 "400": 1939 $ref: "#/components/responses/Err400" 1940 description: VALIDATION_ERROR — request validation failed. 1941 "401": 1942 $ref: "#/components/responses/Err401" 1943 description: UNAUTHORIZED — missing/invalid credentials. 1944 "403": 1945 $ref: "#/components/responses/Err403" 1946 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1947 "404": 1948 $ref: "#/components/responses/Err404" 1949 description: NOT_FOUND — resource does not exist for this caller. 1950 "429": 1951 $ref: "#/components/responses/Err429" 1952 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1953 "500": 1954 $ref: "#/components/responses/Err500" 1955 description: INTERNAL_ERROR — unexpected server error. 1956 /databases/{id}/properties: 1957 get: 1958 operationId: GetDatabasesByIdProperties 1959 tags: 1960 - Databases 1961 summary: Get databases by id 1962 security: 1963 - bearerAuth: [] 1964 parameters: 1965 - name: id 1966 in: path 1967 required: true 1968 schema: 1969 type: string 1970 responses: 1971 "200": 1972 description: OK. 1973 content: 1974 application/json: 1975 schema: 1976 type: object 1977 "401": 1978 $ref: "#/components/responses/Err401" 1979 description: UNAUTHORIZED — missing/invalid credentials. 1980 "403": 1981 $ref: "#/components/responses/Err403" 1982 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 1983 "404": 1984 $ref: "#/components/responses/Err404" 1985 description: NOT_FOUND — resource does not exist for this caller. 1986 "429": 1987 $ref: "#/components/responses/Err429" 1988 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 1989 "500": 1990 $ref: "#/components/responses/Err500" 1991 description: INTERNAL_ERROR — unexpected server error. 1992 post: 1993 operationId: PostDatabasesByIdProperties 1994 tags: 1995 - Databases 1996 summary: Create databases by id 1997 security: 1998 - bearerAuth: [] 1999 parameters: 2000 - name: id 2001 in: path 2002 required: true 2003 schema: 2004 type: string 2005 - $ref: "#/components/parameters/IdempotencyKey" 2006 responses: 2007 "201": 2008 description: The created resource. 2009 content: 2010 application/json: 2011 schema: 2012 type: object 2013 "400": 2014 $ref: "#/components/responses/Err400" 2015 description: VALIDATION_ERROR — request validation failed. 2016 "401": 2017 $ref: "#/components/responses/Err401" 2018 description: UNAUTHORIZED — missing/invalid credentials. 2019 "403": 2020 $ref: "#/components/responses/Err403" 2021 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2022 "404": 2023 $ref: "#/components/responses/Err404" 2024 description: NOT_FOUND — resource does not exist for this caller. 2025 "409": 2026 $ref: "#/components/responses/Err409" 2027 description: CONFLICT — duplicate or state conflict. 2028 "429": 2029 $ref: "#/components/responses/Err429" 2030 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2031 "500": 2032 $ref: "#/components/responses/Err500" 2033 description: INTERNAL_ERROR — unexpected server error. 2034 /databases/{id}/properties/{propertyId}: 2035 patch: 2036 operationId: PatchDatabasesByIdPropertiesByPropertyId 2037 tags: 2038 - Databases 2039 summary: Update databases by id + propertyId 2040 security: 2041 - bearerAuth: [] 2042 parameters: 2043 - name: id 2044 in: path 2045 required: true 2046 schema: 2047 type: string 2048 - name: propertyId 2049 in: path 2050 required: true 2051 schema: 2052 type: string 2053 - $ref: "#/components/parameters/IdempotencyKey" 2054 responses: 2055 "200": 2056 description: OK. 2057 content: 2058 application/json: 2059 schema: 2060 type: object 2061 "400": 2062 $ref: "#/components/responses/Err400" 2063 description: VALIDATION_ERROR — request validation failed. 2064 "401": 2065 $ref: "#/components/responses/Err401" 2066 description: UNAUTHORIZED — missing/invalid credentials. 2067 "403": 2068 $ref: "#/components/responses/Err403" 2069 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2070 "404": 2071 $ref: "#/components/responses/Err404" 2072 description: NOT_FOUND — resource does not exist for this caller. 2073 "409": 2074 $ref: "#/components/responses/Err409" 2075 description: CONFLICT — duplicate or state conflict. 2076 "429": 2077 $ref: "#/components/responses/Err429" 2078 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2079 "500": 2080 $ref: "#/components/responses/Err500" 2081 description: INTERNAL_ERROR — unexpected server error. 2082 delete: 2083 operationId: DeleteDatabasesByIdPropertiesByPropertyId 2084 tags: 2085 - Databases 2086 summary: Delete databases by id + propertyId 2087 security: 2088 - bearerAuth: [] 2089 parameters: 2090 - name: id 2091 in: path 2092 required: true 2093 schema: 2094 type: string 2095 - name: propertyId 2096 in: path 2097 required: true 2098 schema: 2099 type: string 2100 - $ref: "#/components/parameters/IdempotencyKey" 2101 responses: 2102 "200": 2103 description: OK. 2104 content: 2105 application/json: 2106 schema: 2107 type: object 2108 "400": 2109 $ref: "#/components/responses/Err400" 2110 description: VALIDATION_ERROR — request validation failed. 2111 "401": 2112 $ref: "#/components/responses/Err401" 2113 description: UNAUTHORIZED — missing/invalid credentials. 2114 "403": 2115 $ref: "#/components/responses/Err403" 2116 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2117 "404": 2118 $ref: "#/components/responses/Err404" 2119 description: NOT_FOUND — resource does not exist for this caller. 2120 "429": 2121 $ref: "#/components/responses/Err429" 2122 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2123 "500": 2124 $ref: "#/components/responses/Err500" 2125 description: INTERNAL_ERROR — unexpected server error. 2126 /databases/{id}/properties/{propertyId}/reorder: 2127 post: 2128 operationId: PostDatabasesByIdPropertiesByPropertyIdReorder 2129 tags: 2130 - Databases 2131 summary: Create databases by id + propertyId 2132 security: 2133 - bearerAuth: [] 2134 parameters: 2135 - name: id 2136 in: path 2137 required: true 2138 schema: 2139 type: string 2140 - name: propertyId 2141 in: path 2142 required: true 2143 schema: 2144 type: string 2145 - $ref: "#/components/parameters/IdempotencyKey" 2146 responses: 2147 "200": 2148 description: OK. 2149 content: 2150 application/json: 2151 schema: 2152 type: object 2153 "400": 2154 $ref: "#/components/responses/Err400" 2155 description: VALIDATION_ERROR — request validation failed. 2156 "401": 2157 $ref: "#/components/responses/Err401" 2158 description: UNAUTHORIZED — missing/invalid credentials. 2159 "403": 2160 $ref: "#/components/responses/Err403" 2161 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2162 "404": 2163 $ref: "#/components/responses/Err404" 2164 description: NOT_FOUND — resource does not exist for this caller. 2165 "429": 2166 $ref: "#/components/responses/Err429" 2167 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2168 "500": 2169 $ref: "#/components/responses/Err500" 2170 description: INTERNAL_ERROR — unexpected server error. 2171 /databases/{id}/query: 2172 post: 2173 operationId: PostDatabasesByIdQuery 2174 tags: 2175 - Databases 2176 summary: Create databases by id 2177 security: 2178 - bearerAuth: [] 2179 parameters: 2180 - name: id 2181 in: path 2182 required: true 2183 schema: 2184 type: string 2185 - $ref: "#/components/parameters/IdempotencyKey" 2186 responses: 2187 "200": 2188 description: OK. 2189 content: 2190 application/json: 2191 schema: 2192 type: object 2193 "400": 2194 $ref: "#/components/responses/Err400" 2195 description: VALIDATION_ERROR — request validation failed. 2196 "401": 2197 $ref: "#/components/responses/Err401" 2198 description: UNAUTHORIZED — missing/invalid credentials. 2199 "403": 2200 $ref: "#/components/responses/Err403" 2201 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2202 "404": 2203 $ref: "#/components/responses/Err404" 2204 description: NOT_FOUND — resource does not exist for this caller. 2205 "429": 2206 $ref: "#/components/responses/Err429" 2207 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2208 "500": 2209 $ref: "#/components/responses/Err500" 2210 description: INTERNAL_ERROR — unexpected server error. 2211 /databases/{id}/records: 2212 get: 2213 operationId: GetDatabasesByIdRecords 2214 tags: 2215 - Databases 2216 summary: Get databases by id 2217 security: 2218 - bearerAuth: [] 2219 parameters: 2220 - name: id 2221 in: path 2222 required: true 2223 schema: 2224 type: string 2225 responses: 2226 "200": 2227 description: OK. 2228 content: 2229 application/json: 2230 schema: 2231 type: object 2232 "401": 2233 $ref: "#/components/responses/Err401" 2234 description: UNAUTHORIZED — missing/invalid credentials. 2235 "403": 2236 $ref: "#/components/responses/Err403" 2237 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2238 "404": 2239 $ref: "#/components/responses/Err404" 2240 description: NOT_FOUND — resource does not exist for this caller. 2241 "429": 2242 $ref: "#/components/responses/Err429" 2243 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2244 "500": 2245 $ref: "#/components/responses/Err500" 2246 description: INTERNAL_ERROR — unexpected server error. 2247 post: 2248 operationId: PostDatabasesByIdRecords 2249 tags: 2250 - Databases 2251 summary: Create databases by id 2252 security: 2253 - bearerAuth: [] 2254 parameters: 2255 - name: id 2256 in: path 2257 required: true 2258 schema: 2259 type: string 2260 - $ref: "#/components/parameters/IdempotencyKey" 2261 responses: 2262 "201": 2263 description: The created resource. 2264 content: 2265 application/json: 2266 schema: 2267 type: object 2268 "400": 2269 $ref: "#/components/responses/Err400" 2270 description: VALIDATION_ERROR — request validation failed. 2271 "401": 2272 $ref: "#/components/responses/Err401" 2273 description: UNAUTHORIZED — missing/invalid credentials. 2274 "403": 2275 $ref: "#/components/responses/Err403" 2276 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2277 "404": 2278 $ref: "#/components/responses/Err404" 2279 description: NOT_FOUND — resource does not exist for this caller. 2280 "409": 2281 $ref: "#/components/responses/Err409" 2282 description: CONFLICT — duplicate or state conflict. 2283 "429": 2284 $ref: "#/components/responses/Err429" 2285 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2286 "500": 2287 $ref: "#/components/responses/Err500" 2288 description: INTERNAL_ERROR — unexpected server error. 2289 /databases/{id}/records/bulk: 2290 post: 2291 operationId: PostDatabasesByIdRecordsBulk 2292 tags: 2293 - Databases 2294 summary: Create databases by id 2295 security: 2296 - bearerAuth: [] 2297 parameters: 2298 - name: id 2299 in: path 2300 required: true 2301 schema: 2302 type: string 2303 - $ref: "#/components/parameters/IdempotencyKey" 2304 responses: 2305 "200": 2306 description: OK. 2307 content: 2308 application/json: 2309 schema: 2310 type: object 2311 "400": 2312 $ref: "#/components/responses/Err400" 2313 description: VALIDATION_ERROR — request validation failed. 2314 "401": 2315 $ref: "#/components/responses/Err401" 2316 description: UNAUTHORIZED — missing/invalid credentials. 2317 "403": 2318 $ref: "#/components/responses/Err403" 2319 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2320 "404": 2321 $ref: "#/components/responses/Err404" 2322 description: NOT_FOUND — resource does not exist for this caller. 2323 "429": 2324 $ref: "#/components/responses/Err429" 2325 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2326 "500": 2327 $ref: "#/components/responses/Err500" 2328 description: INTERNAL_ERROR — unexpected server error. 2329 /databases/{id}/relations: 2330 get: 2331 operationId: GetDatabasesByIdRelations 2332 tags: 2333 - Databases 2334 summary: Get databases by id 2335 security: 2336 - bearerAuth: [] 2337 parameters: 2338 - name: id 2339 in: path 2340 required: true 2341 schema: 2342 type: string 2343 responses: 2344 "200": 2345 description: OK. 2346 content: 2347 application/json: 2348 schema: 2349 type: object 2350 "401": 2351 $ref: "#/components/responses/Err401" 2352 description: UNAUTHORIZED — missing/invalid credentials. 2353 "403": 2354 $ref: "#/components/responses/Err403" 2355 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2356 "404": 2357 $ref: "#/components/responses/Err404" 2358 description: NOT_FOUND — resource does not exist for this caller. 2359 "429": 2360 $ref: "#/components/responses/Err429" 2361 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2362 "500": 2363 $ref: "#/components/responses/Err500" 2364 description: INTERNAL_ERROR — unexpected server error. 2365 post: 2366 operationId: PostDatabasesByIdRelations 2367 tags: 2368 - Databases 2369 summary: Create databases by id 2370 security: 2371 - bearerAuth: [] 2372 parameters: 2373 - name: id 2374 in: path 2375 required: true 2376 schema: 2377 type: string 2378 - $ref: "#/components/parameters/IdempotencyKey" 2379 responses: 2380 "201": 2381 description: The created resource. 2382 content: 2383 application/json: 2384 schema: 2385 type: object 2386 "400": 2387 $ref: "#/components/responses/Err400" 2388 description: VALIDATION_ERROR — request validation failed. 2389 "401": 2390 $ref: "#/components/responses/Err401" 2391 description: UNAUTHORIZED — missing/invalid credentials. 2392 "403": 2393 $ref: "#/components/responses/Err403" 2394 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2395 "404": 2396 $ref: "#/components/responses/Err404" 2397 description: NOT_FOUND — resource does not exist for this caller. 2398 "409": 2399 $ref: "#/components/responses/Err409" 2400 description: CONFLICT — duplicate or state conflict. 2401 "429": 2402 $ref: "#/components/responses/Err429" 2403 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2404 "500": 2405 $ref: "#/components/responses/Err500" 2406 description: INTERNAL_ERROR — unexpected server error. 2407 /databases/{id}/relations/{relationId}: 2408 patch: 2409 operationId: PatchDatabasesByIdRelationsByRelationId 2410 tags: 2411 - Databases 2412 summary: Update databases by id + relationId 2413 security: 2414 - bearerAuth: [] 2415 parameters: 2416 - name: id 2417 in: path 2418 required: true 2419 schema: 2420 type: string 2421 - name: relationId 2422 in: path 2423 required: true 2424 schema: 2425 type: string 2426 - $ref: "#/components/parameters/IdempotencyKey" 2427 responses: 2428 "200": 2429 description: OK. 2430 content: 2431 application/json: 2432 schema: 2433 type: object 2434 "400": 2435 $ref: "#/components/responses/Err400" 2436 description: VALIDATION_ERROR — request validation failed. 2437 "401": 2438 $ref: "#/components/responses/Err401" 2439 description: UNAUTHORIZED — missing/invalid credentials. 2440 "403": 2441 $ref: "#/components/responses/Err403" 2442 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2443 "404": 2444 $ref: "#/components/responses/Err404" 2445 description: NOT_FOUND — resource does not exist for this caller. 2446 "409": 2447 $ref: "#/components/responses/Err409" 2448 description: CONFLICT — duplicate or state conflict. 2449 "429": 2450 $ref: "#/components/responses/Err429" 2451 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2452 "500": 2453 $ref: "#/components/responses/Err500" 2454 description: INTERNAL_ERROR — unexpected server error. 2455 delete: 2456 operationId: DeleteDatabasesByIdRelationsByRelationId 2457 tags: 2458 - Databases 2459 summary: Delete databases by id + relationId 2460 security: 2461 - bearerAuth: [] 2462 parameters: 2463 - name: id 2464 in: path 2465 required: true 2466 schema: 2467 type: string 2468 - name: relationId 2469 in: path 2470 required: true 2471 schema: 2472 type: string 2473 - $ref: "#/components/parameters/IdempotencyKey" 2474 responses: 2475 "200": 2476 description: OK. 2477 content: 2478 application/json: 2479 schema: 2480 type: object 2481 "400": 2482 $ref: "#/components/responses/Err400" 2483 description: VALIDATION_ERROR — request validation failed. 2484 "401": 2485 $ref: "#/components/responses/Err401" 2486 description: UNAUTHORIZED — missing/invalid credentials. 2487 "403": 2488 $ref: "#/components/responses/Err403" 2489 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2490 "404": 2491 $ref: "#/components/responses/Err404" 2492 description: NOT_FOUND — resource does not exist for this caller. 2493 "429": 2494 $ref: "#/components/responses/Err429" 2495 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2496 "500": 2497 $ref: "#/components/responses/Err500" 2498 description: INTERNAL_ERROR — unexpected server error. 2499 /databases/{id}/views: 2500 get: 2501 operationId: GetDatabasesByIdViews 2502 tags: 2503 - Databases 2504 summary: Get databases by id 2505 security: 2506 - bearerAuth: [] 2507 parameters: 2508 - name: id 2509 in: path 2510 required: true 2511 schema: 2512 type: string 2513 responses: 2514 "200": 2515 description: OK. 2516 content: 2517 application/json: 2518 schema: 2519 type: object 2520 "401": 2521 $ref: "#/components/responses/Err401" 2522 description: UNAUTHORIZED — missing/invalid credentials. 2523 "403": 2524 $ref: "#/components/responses/Err403" 2525 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2526 "404": 2527 $ref: "#/components/responses/Err404" 2528 description: NOT_FOUND — resource does not exist for this caller. 2529 "429": 2530 $ref: "#/components/responses/Err429" 2531 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2532 "500": 2533 $ref: "#/components/responses/Err500" 2534 description: INTERNAL_ERROR — unexpected server error. 2535 post: 2536 operationId: PostDatabasesByIdViews 2537 tags: 2538 - Databases 2539 summary: Create databases by id 2540 security: 2541 - bearerAuth: [] 2542 parameters: 2543 - name: id 2544 in: path 2545 required: true 2546 schema: 2547 type: string 2548 - $ref: "#/components/parameters/IdempotencyKey" 2549 responses: 2550 "201": 2551 description: The created resource. 2552 content: 2553 application/json: 2554 schema: 2555 type: object 2556 "400": 2557 $ref: "#/components/responses/Err400" 2558 description: VALIDATION_ERROR — request validation failed. 2559 "401": 2560 $ref: "#/components/responses/Err401" 2561 description: UNAUTHORIZED — missing/invalid credentials. 2562 "403": 2563 $ref: "#/components/responses/Err403" 2564 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2565 "404": 2566 $ref: "#/components/responses/Err404" 2567 description: NOT_FOUND — resource does not exist for this caller. 2568 "409": 2569 $ref: "#/components/responses/Err409" 2570 description: CONFLICT — duplicate or state conflict. 2571 "429": 2572 $ref: "#/components/responses/Err429" 2573 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2574 "500": 2575 $ref: "#/components/responses/Err500" 2576 description: INTERNAL_ERROR — unexpected server error. 2577 /databases/{id}/views/{viewId}: 2578 patch: 2579 operationId: PatchDatabasesByIdViewsByViewId 2580 tags: 2581 - Databases 2582 summary: Update databases by id + viewId 2583 security: 2584 - bearerAuth: [] 2585 parameters: 2586 - name: id 2587 in: path 2588 required: true 2589 schema: 2590 type: string 2591 - name: viewId 2592 in: path 2593 required: true 2594 schema: 2595 type: string 2596 - $ref: "#/components/parameters/IdempotencyKey" 2597 responses: 2598 "200": 2599 description: OK. 2600 content: 2601 application/json: 2602 schema: 2603 type: object 2604 "400": 2605 $ref: "#/components/responses/Err400" 2606 description: VALIDATION_ERROR — request validation failed. 2607 "401": 2608 $ref: "#/components/responses/Err401" 2609 description: UNAUTHORIZED — missing/invalid credentials. 2610 "403": 2611 $ref: "#/components/responses/Err403" 2612 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2613 "404": 2614 $ref: "#/components/responses/Err404" 2615 description: NOT_FOUND — resource does not exist for this caller. 2616 "409": 2617 $ref: "#/components/responses/Err409" 2618 description: CONFLICT — duplicate or state conflict. 2619 "429": 2620 $ref: "#/components/responses/Err429" 2621 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2622 "500": 2623 $ref: "#/components/responses/Err500" 2624 description: INTERNAL_ERROR — unexpected server error. 2625 delete: 2626 operationId: DeleteDatabasesByIdViewsByViewId 2627 tags: 2628 - Databases 2629 summary: Delete databases by id + viewId 2630 security: 2631 - bearerAuth: [] 2632 parameters: 2633 - name: id 2634 in: path 2635 required: true 2636 schema: 2637 type: string 2638 - name: viewId 2639 in: path 2640 required: true 2641 schema: 2642 type: string 2643 - $ref: "#/components/parameters/IdempotencyKey" 2644 responses: 2645 "200": 2646 description: OK. 2647 content: 2648 application/json: 2649 schema: 2650 type: object 2651 "400": 2652 $ref: "#/components/responses/Err400" 2653 description: VALIDATION_ERROR — request validation failed. 2654 "401": 2655 $ref: "#/components/responses/Err401" 2656 description: UNAUTHORIZED — missing/invalid credentials. 2657 "403": 2658 $ref: "#/components/responses/Err403" 2659 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2660 "404": 2661 $ref: "#/components/responses/Err404" 2662 description: NOT_FOUND — resource does not exist for this caller. 2663 "429": 2664 $ref: "#/components/responses/Err429" 2665 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2666 "500": 2667 $ref: "#/components/responses/Err500" 2668 description: INTERNAL_ERROR — unexpected server error. 2669 /databases/{id}/views/{viewId}/reorder: 2670 post: 2671 operationId: PostDatabasesByIdViewsByViewIdReorder 2672 tags: 2673 - Databases 2674 summary: Create databases by id + viewId 2675 security: 2676 - bearerAuth: [] 2677 parameters: 2678 - name: id 2679 in: path 2680 required: true 2681 schema: 2682 type: string 2683 - name: viewId 2684 in: path 2685 required: true 2686 schema: 2687 type: string 2688 - $ref: "#/components/parameters/IdempotencyKey" 2689 responses: 2690 "200": 2691 description: OK. 2692 content: 2693 application/json: 2694 schema: 2695 type: object 2696 "400": 2697 $ref: "#/components/responses/Err400" 2698 description: VALIDATION_ERROR — request validation failed. 2699 "401": 2700 $ref: "#/components/responses/Err401" 2701 description: UNAUTHORIZED — missing/invalid credentials. 2702 "403": 2703 $ref: "#/components/responses/Err403" 2704 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2705 "404": 2706 $ref: "#/components/responses/Err404" 2707 description: NOT_FOUND — resource does not exist for this caller. 2708 "429": 2709 $ref: "#/components/responses/Err429" 2710 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2711 "500": 2712 $ref: "#/components/responses/Err500" 2713 description: INTERNAL_ERROR — unexpected server error. 2714 /debug/events: 2715 get: 2716 operationId: GetDebugEvents 2717 tags: 2718 - Debug 2719 summary: List debug 2720 security: [] 2721 parameters: [] 2722 responses: 2723 "200": 2724 description: OK. 2725 content: 2726 application/json: 2727 schema: 2728 type: object 2729 "429": 2730 $ref: "#/components/responses/Err429" 2731 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2732 "500": 2733 $ref: "#/components/responses/Err500" 2734 description: INTERNAL_ERROR — unexpected server error. 2735 /docs: 2736 get: 2737 operationId: GetDocs 2738 tags: 2739 - API Docs 2740 summary: Interactive API documentation (swagger-ui) 2741 security: [] 2742 parameters: [] 2743 responses: 2744 "200": 2745 description: OK. 2746 content: 2747 application/json: 2748 schema: 2749 type: object 2750 "429": 2751 $ref: "#/components/responses/Err429" 2752 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2753 "500": 2754 $ref: "#/components/responses/Err500" 2755 description: INTERNAL_ERROR — unexpected server error. 2756 /docs/assets/{file}: 2757 get: 2758 operationId: GetDocsAssetsByFile 2759 tags: 2760 - API Docs 2761 summary: Get api docs by file 2762 security: [] 2763 parameters: 2764 - name: file 2765 in: path 2766 required: true 2767 schema: 2768 type: string 2769 responses: 2770 "200": 2771 description: OK. 2772 content: 2773 application/json: 2774 schema: 2775 type: object 2776 "429": 2777 $ref: "#/components/responses/Err429" 2778 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2779 "500": 2780 $ref: "#/components/responses/Err500" 2781 description: INTERNAL_ERROR — unexpected server error. 2782 /docs/openapi.yaml: 2783 get: 2784 operationId: GetDocsOpenapiYaml 2785 tags: 2786 - API Docs 2787 summary: Download the OpenAPI 3.1 spec (YAML) 2788 security: [] 2789 parameters: [] 2790 responses: 2791 "200": 2792 description: OK. 2793 content: 2794 application/json: 2795 schema: 2796 type: object 2797 "429": 2798 $ref: "#/components/responses/Err429" 2799 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2800 "500": 2801 $ref: "#/components/responses/Err500" 2802 description: INTERNAL_ERROR — unexpected server error. 2803 /files: 2804 get: 2805 operationId: GetFiles 2806 tags: 2807 - Files 2808 summary: List files 2809 security: 2810 - bearerAuth: [] 2811 parameters: [] 2812 responses: 2813 "200": 2814 description: OK. 2815 content: 2816 application/json: 2817 schema: 2818 type: object 2819 "401": 2820 $ref: "#/components/responses/Err401" 2821 description: UNAUTHORIZED — missing/invalid credentials. 2822 "403": 2823 $ref: "#/components/responses/Err403" 2824 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2825 "404": 2826 $ref: "#/components/responses/Err404" 2827 description: NOT_FOUND — resource does not exist for this caller. 2828 "429": 2829 $ref: "#/components/responses/Err429" 2830 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2831 "500": 2832 $ref: "#/components/responses/Err500" 2833 description: INTERNAL_ERROR — unexpected server error. 2834 /files/{id}: 2835 get: 2836 operationId: GetFilesById 2837 tags: 2838 - Files 2839 summary: Get files by id 2840 security: 2841 - bearerAuth: [] 2842 parameters: 2843 - name: id 2844 in: path 2845 required: true 2846 schema: 2847 type: string 2848 responses: 2849 "200": 2850 description: OK. 2851 content: 2852 application/json: 2853 schema: 2854 type: object 2855 "401": 2856 $ref: "#/components/responses/Err401" 2857 description: UNAUTHORIZED — missing/invalid credentials. 2858 "403": 2859 $ref: "#/components/responses/Err403" 2860 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2861 "404": 2862 $ref: "#/components/responses/Err404" 2863 description: NOT_FOUND — resource does not exist for this caller. 2864 "429": 2865 $ref: "#/components/responses/Err429" 2866 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2867 "500": 2868 $ref: "#/components/responses/Err500" 2869 description: INTERNAL_ERROR — unexpected server error. 2870 delete: 2871 operationId: DeleteFilesById 2872 tags: 2873 - Files 2874 summary: Delete files by id 2875 security: 2876 - bearerAuth: [] 2877 parameters: 2878 - name: id 2879 in: path 2880 required: true 2881 schema: 2882 type: string 2883 - $ref: "#/components/parameters/IdempotencyKey" 2884 responses: 2885 "200": 2886 description: OK. 2887 content: 2888 application/json: 2889 schema: 2890 type: object 2891 "400": 2892 $ref: "#/components/responses/Err400" 2893 description: VALIDATION_ERROR — request validation failed. 2894 "401": 2895 $ref: "#/components/responses/Err401" 2896 description: UNAUTHORIZED — missing/invalid credentials. 2897 "403": 2898 $ref: "#/components/responses/Err403" 2899 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2900 "404": 2901 $ref: "#/components/responses/Err404" 2902 description: NOT_FOUND — resource does not exist for this caller. 2903 "429": 2904 $ref: "#/components/responses/Err429" 2905 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2906 "500": 2907 $ref: "#/components/responses/Err500" 2908 description: INTERNAL_ERROR — unexpected server error. 2909 patch: 2910 operationId: PatchFilesById 2911 tags: 2912 - Files 2913 summary: Update files by id 2914 security: 2915 - bearerAuth: [] 2916 parameters: 2917 - name: id 2918 in: path 2919 required: true 2920 schema: 2921 type: string 2922 - $ref: "#/components/parameters/IdempotencyKey" 2923 responses: 2924 "200": 2925 description: OK. 2926 content: 2927 application/json: 2928 schema: 2929 type: object 2930 "400": 2931 $ref: "#/components/responses/Err400" 2932 description: VALIDATION_ERROR — request validation failed. 2933 "401": 2934 $ref: "#/components/responses/Err401" 2935 description: UNAUTHORIZED — missing/invalid credentials. 2936 "403": 2937 $ref: "#/components/responses/Err403" 2938 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2939 "404": 2940 $ref: "#/components/responses/Err404" 2941 description: NOT_FOUND — resource does not exist for this caller. 2942 "409": 2943 $ref: "#/components/responses/Err409" 2944 description: CONFLICT — duplicate or state conflict. 2945 "429": 2946 $ref: "#/components/responses/Err429" 2947 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2948 "500": 2949 $ref: "#/components/responses/Err500" 2950 description: INTERNAL_ERROR — unexpected server error. 2951 /files/{id}/download: 2952 get: 2953 operationId: GetFilesByIdDownload 2954 tags: 2955 - Files 2956 summary: Get files by id 2957 security: 2958 - bearerAuth: [] 2959 parameters: 2960 - name: id 2961 in: path 2962 required: true 2963 schema: 2964 type: string 2965 responses: 2966 "200": 2967 description: OK. 2968 content: 2969 application/json: 2970 schema: 2971 type: object 2972 "401": 2973 $ref: "#/components/responses/Err401" 2974 description: UNAUTHORIZED — missing/invalid credentials. 2975 "403": 2976 $ref: "#/components/responses/Err403" 2977 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 2978 "404": 2979 $ref: "#/components/responses/Err404" 2980 description: NOT_FOUND — resource does not exist for this caller. 2981 "429": 2982 $ref: "#/components/responses/Err429" 2983 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 2984 "500": 2985 $ref: "#/components/responses/Err500" 2986 description: INTERNAL_ERROR — unexpected server error. 2987 /files/{id}/permissions: 2988 get: 2989 operationId: GetFilesByIdPermissions 2990 tags: 2991 - Files 2992 summary: Get files by id 2993 security: 2994 - bearerAuth: [] 2995 parameters: 2996 - name: id 2997 in: path 2998 required: true 2999 schema: 3000 type: string 3001 responses: 3002 "200": 3003 description: OK. 3004 content: 3005 application/json: 3006 schema: 3007 type: object 3008 "401": 3009 $ref: "#/components/responses/Err401" 3010 description: UNAUTHORIZED — missing/invalid credentials. 3011 "403": 3012 $ref: "#/components/responses/Err403" 3013 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3014 "404": 3015 $ref: "#/components/responses/Err404" 3016 description: NOT_FOUND — resource does not exist for this caller. 3017 "429": 3018 $ref: "#/components/responses/Err429" 3019 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3020 "500": 3021 $ref: "#/components/responses/Err500" 3022 description: INTERNAL_ERROR — unexpected server error. 3023 put: 3024 operationId: PutFilesByIdPermissions 3025 tags: 3026 - Files 3027 summary: Replace files by id 3028 security: 3029 - bearerAuth: [] 3030 parameters: 3031 - name: id 3032 in: path 3033 required: true 3034 schema: 3035 type: string 3036 - $ref: "#/components/parameters/IdempotencyKey" 3037 responses: 3038 "200": 3039 description: OK. 3040 content: 3041 application/json: 3042 schema: 3043 type: object 3044 "400": 3045 $ref: "#/components/responses/Err400" 3046 description: VALIDATION_ERROR — request validation failed. 3047 "401": 3048 $ref: "#/components/responses/Err401" 3049 description: UNAUTHORIZED — missing/invalid credentials. 3050 "403": 3051 $ref: "#/components/responses/Err403" 3052 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3053 "404": 3054 $ref: "#/components/responses/Err404" 3055 description: NOT_FOUND — resource does not exist for this caller. 3056 "409": 3057 $ref: "#/components/responses/Err409" 3058 description: CONFLICT — duplicate or state conflict. 3059 "429": 3060 $ref: "#/components/responses/Err429" 3061 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3062 "500": 3063 $ref: "#/components/responses/Err500" 3064 description: INTERNAL_ERROR — unexpected server error. 3065 /files/{id}/preview: 3066 get: 3067 operationId: GetFilesByIdPreview 3068 tags: 3069 - Files 3070 summary: Get files by id 3071 security: 3072 - bearerAuth: [] 3073 parameters: 3074 - name: id 3075 in: path 3076 required: true 3077 schema: 3078 type: string 3079 responses: 3080 "200": 3081 description: OK. 3082 content: 3083 application/json: 3084 schema: 3085 type: object 3086 "401": 3087 $ref: "#/components/responses/Err401" 3088 description: UNAUTHORIZED — missing/invalid credentials. 3089 "403": 3090 $ref: "#/components/responses/Err403" 3091 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3092 "404": 3093 $ref: "#/components/responses/Err404" 3094 description: NOT_FOUND — resource does not exist for this caller. 3095 "429": 3096 $ref: "#/components/responses/Err429" 3097 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3098 "500": 3099 $ref: "#/components/responses/Err500" 3100 description: INTERNAL_ERROR — unexpected server error. 3101 /files/{id}/restore: 3102 post: 3103 operationId: PostFilesByIdRestore 3104 tags: 3105 - Files 3106 summary: Restore a file from the trash 3107 security: 3108 - bearerAuth: [] 3109 parameters: 3110 - name: id 3111 in: path 3112 required: true 3113 schema: 3114 type: string 3115 - $ref: "#/components/parameters/IdempotencyKey" 3116 responses: 3117 "200": 3118 description: OK. 3119 content: 3120 application/json: 3121 schema: 3122 type: object 3123 "400": 3124 $ref: "#/components/responses/Err400" 3125 description: VALIDATION_ERROR — request validation failed. 3126 "401": 3127 $ref: "#/components/responses/Err401" 3128 description: UNAUTHORIZED — missing/invalid credentials. 3129 "403": 3130 $ref: "#/components/responses/Err403" 3131 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3132 "404": 3133 $ref: "#/components/responses/Err404" 3134 description: NOT_FOUND — resource does not exist for this caller. 3135 "429": 3136 $ref: "#/components/responses/Err429" 3137 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3138 "500": 3139 $ref: "#/components/responses/Err500" 3140 description: INTERNAL_ERROR — unexpected server error. 3141 /files/{id}/rollback: 3142 post: 3143 operationId: PostFilesByIdRollback 3144 tags: 3145 - Files 3146 summary: Roll a file back to a previous version 3147 security: 3148 - bearerAuth: [] 3149 parameters: 3150 - name: id 3151 in: path 3152 required: true 3153 schema: 3154 type: string 3155 - $ref: "#/components/parameters/IdempotencyKey" 3156 responses: 3157 "200": 3158 description: OK. 3159 content: 3160 application/json: 3161 schema: 3162 type: object 3163 "400": 3164 $ref: "#/components/responses/Err400" 3165 description: VALIDATION_ERROR — request validation failed. 3166 "401": 3167 $ref: "#/components/responses/Err401" 3168 description: UNAUTHORIZED — missing/invalid credentials. 3169 "403": 3170 $ref: "#/components/responses/Err403" 3171 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3172 "404": 3173 $ref: "#/components/responses/Err404" 3174 description: NOT_FOUND — resource does not exist for this caller. 3175 "429": 3176 $ref: "#/components/responses/Err429" 3177 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3178 "500": 3179 $ref: "#/components/responses/Err500" 3180 description: INTERNAL_ERROR — unexpected server error. 3181 /files/{id}/versions: 3182 get: 3183 operationId: GetFilesByIdVersions 3184 tags: 3185 - Files 3186 summary: Get files by id 3187 security: 3188 - bearerAuth: [] 3189 parameters: 3190 - name: id 3191 in: path 3192 required: true 3193 schema: 3194 type: string 3195 responses: 3196 "200": 3197 description: OK. 3198 content: 3199 application/json: 3200 schema: 3201 type: object 3202 "401": 3203 $ref: "#/components/responses/Err401" 3204 description: UNAUTHORIZED — missing/invalid credentials. 3205 "403": 3206 $ref: "#/components/responses/Err403" 3207 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3208 "404": 3209 $ref: "#/components/responses/Err404" 3210 description: NOT_FOUND — resource does not exist for this caller. 3211 "429": 3212 $ref: "#/components/responses/Err429" 3213 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3214 "500": 3215 $ref: "#/components/responses/Err500" 3216 description: INTERNAL_ERROR — unexpected server error. 3217 /files/{id}/versions/prune: 3218 post: 3219 operationId: PostFilesByIdVersionsPrune 3220 tags: 3221 - Files 3222 summary: Create files by id 3223 security: 3224 - bearerAuth: [] 3225 parameters: 3226 - name: id 3227 in: path 3228 required: true 3229 schema: 3230 type: string 3231 - $ref: "#/components/parameters/IdempotencyKey" 3232 responses: 3233 "200": 3234 description: OK. 3235 content: 3236 application/json: 3237 schema: 3238 type: object 3239 "400": 3240 $ref: "#/components/responses/Err400" 3241 description: VALIDATION_ERROR — request validation failed. 3242 "401": 3243 $ref: "#/components/responses/Err401" 3244 description: UNAUTHORIZED — missing/invalid credentials. 3245 "403": 3246 $ref: "#/components/responses/Err403" 3247 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3248 "404": 3249 $ref: "#/components/responses/Err404" 3250 description: NOT_FOUND — resource does not exist for this caller. 3251 "429": 3252 $ref: "#/components/responses/Err429" 3253 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3254 "500": 3255 $ref: "#/components/responses/Err500" 3256 description: INTERNAL_ERROR — unexpected server error. 3257 /files/trash: 3258 get: 3259 operationId: GetFilesTrash 3260 tags: 3261 - Files 3262 summary: List files 3263 security: 3264 - bearerAuth: [] 3265 parameters: [] 3266 responses: 3267 "200": 3268 description: OK. 3269 content: 3270 application/json: 3271 schema: 3272 type: object 3273 "401": 3274 $ref: "#/components/responses/Err401" 3275 description: UNAUTHORIZED — missing/invalid credentials. 3276 "403": 3277 $ref: "#/components/responses/Err403" 3278 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3279 "404": 3280 $ref: "#/components/responses/Err404" 3281 description: NOT_FOUND — resource does not exist for this caller. 3282 "429": 3283 $ref: "#/components/responses/Err429" 3284 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3285 "500": 3286 $ref: "#/components/responses/Err500" 3287 description: INTERNAL_ERROR — unexpected server error. 3288 /files/uploads: 3289 post: 3290 operationId: PostFilesUploads 3291 tags: 3292 - Files 3293 summary: Create files 3294 security: 3295 - bearerAuth: [] 3296 parameters: 3297 - $ref: "#/components/parameters/IdempotencyKey" 3298 responses: 3299 "201": 3300 description: The created resource. 3301 content: 3302 application/json: 3303 schema: 3304 type: object 3305 "400": 3306 $ref: "#/components/responses/Err400" 3307 description: VALIDATION_ERROR — request validation failed. 3308 "401": 3309 $ref: "#/components/responses/Err401" 3310 description: UNAUTHORIZED — missing/invalid credentials. 3311 "403": 3312 $ref: "#/components/responses/Err403" 3313 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3314 "404": 3315 $ref: "#/components/responses/Err404" 3316 description: NOT_FOUND — resource does not exist for this caller. 3317 "409": 3318 $ref: "#/components/responses/Err409" 3319 description: CONFLICT — duplicate or state conflict. 3320 "429": 3321 $ref: "#/components/responses/Err429" 3322 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3323 "500": 3324 $ref: "#/components/responses/Err500" 3325 description: INTERNAL_ERROR — unexpected server error. 3326 /files/uploads/{id}/cancel: 3327 post: 3328 operationId: PostFilesUploadsByIdCancel 3329 tags: 3330 - Files 3331 summary: Create files by id 3332 security: 3333 - bearerAuth: [] 3334 parameters: 3335 - name: id 3336 in: path 3337 required: true 3338 schema: 3339 type: string 3340 - $ref: "#/components/parameters/IdempotencyKey" 3341 responses: 3342 "200": 3343 description: OK. 3344 content: 3345 application/json: 3346 schema: 3347 type: object 3348 "400": 3349 $ref: "#/components/responses/Err400" 3350 description: VALIDATION_ERROR — request validation failed. 3351 "401": 3352 $ref: "#/components/responses/Err401" 3353 description: UNAUTHORIZED — missing/invalid credentials. 3354 "403": 3355 $ref: "#/components/responses/Err403" 3356 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3357 "404": 3358 $ref: "#/components/responses/Err404" 3359 description: NOT_FOUND — resource does not exist for this caller. 3360 "429": 3361 $ref: "#/components/responses/Err429" 3362 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3363 "500": 3364 $ref: "#/components/responses/Err500" 3365 description: INTERNAL_ERROR — unexpected server error. 3366 /files/uploads/{id}/complete: 3367 put: 3368 operationId: PutFilesUploadsByIdComplete 3369 tags: 3370 - Files 3371 summary: Replace files by id 3372 security: 3373 - bearerAuth: [] 3374 parameters: 3375 - name: id 3376 in: path 3377 required: true 3378 schema: 3379 type: string 3380 - $ref: "#/components/parameters/IdempotencyKey" 3381 responses: 3382 "200": 3383 description: OK. 3384 content: 3385 application/json: 3386 schema: 3387 type: object 3388 "400": 3389 $ref: "#/components/responses/Err400" 3390 description: VALIDATION_ERROR — request validation failed. 3391 "401": 3392 $ref: "#/components/responses/Err401" 3393 description: UNAUTHORIZED — missing/invalid credentials. 3394 "403": 3395 $ref: "#/components/responses/Err403" 3396 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3397 "404": 3398 $ref: "#/components/responses/Err404" 3399 description: NOT_FOUND — resource does not exist for this caller. 3400 "409": 3401 $ref: "#/components/responses/Err409" 3402 description: CONFLICT — duplicate or state conflict. 3403 "429": 3404 $ref: "#/components/responses/Err429" 3405 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3406 "500": 3407 $ref: "#/components/responses/Err500" 3408 description: INTERNAL_ERROR — unexpected server error. 3409 /forms/{formId}: 3410 get: 3411 operationId: GetFormsByFormId 3412 tags: 3413 - Forms 3414 summary: Get forms by formId 3415 security: 3416 - bearerAuth: [] 3417 parameters: 3418 - name: formId 3419 in: path 3420 required: true 3421 schema: 3422 type: string 3423 responses: 3424 "200": 3425 description: OK. 3426 content: 3427 application/json: 3428 schema: 3429 type: object 3430 "401": 3431 $ref: "#/components/responses/Err401" 3432 description: UNAUTHORIZED — missing/invalid credentials. 3433 "403": 3434 $ref: "#/components/responses/Err403" 3435 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3436 "404": 3437 $ref: "#/components/responses/Err404" 3438 description: NOT_FOUND — resource does not exist for this caller. 3439 "429": 3440 $ref: "#/components/responses/Err429" 3441 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3442 "500": 3443 $ref: "#/components/responses/Err500" 3444 description: INTERNAL_ERROR — unexpected server error. 3445 patch: 3446 operationId: PatchFormsByFormId 3447 tags: 3448 - Forms 3449 summary: Update forms by formId 3450 security: 3451 - bearerAuth: [] 3452 parameters: 3453 - name: formId 3454 in: path 3455 required: true 3456 schema: 3457 type: string 3458 - $ref: "#/components/parameters/IdempotencyKey" 3459 responses: 3460 "200": 3461 description: OK. 3462 content: 3463 application/json: 3464 schema: 3465 type: object 3466 "400": 3467 $ref: "#/components/responses/Err400" 3468 description: VALIDATION_ERROR — request validation failed. 3469 "401": 3470 $ref: "#/components/responses/Err401" 3471 description: UNAUTHORIZED — missing/invalid credentials. 3472 "403": 3473 $ref: "#/components/responses/Err403" 3474 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3475 "404": 3476 $ref: "#/components/responses/Err404" 3477 description: NOT_FOUND — resource does not exist for this caller. 3478 "409": 3479 $ref: "#/components/responses/Err409" 3480 description: CONFLICT — duplicate or state conflict. 3481 "429": 3482 $ref: "#/components/responses/Err429" 3483 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3484 "500": 3485 $ref: "#/components/responses/Err500" 3486 description: INTERNAL_ERROR — unexpected server error. 3487 delete: 3488 operationId: DeleteFormsByFormId 3489 tags: 3490 - Forms 3491 summary: Delete forms by formId 3492 security: 3493 - bearerAuth: [] 3494 parameters: 3495 - name: formId 3496 in: path 3497 required: true 3498 schema: 3499 type: string 3500 - $ref: "#/components/parameters/IdempotencyKey" 3501 responses: 3502 "200": 3503 description: OK. 3504 content: 3505 application/json: 3506 schema: 3507 type: object 3508 "400": 3509 $ref: "#/components/responses/Err400" 3510 description: VALIDATION_ERROR — request validation failed. 3511 "401": 3512 $ref: "#/components/responses/Err401" 3513 description: UNAUTHORIZED — missing/invalid credentials. 3514 "403": 3515 $ref: "#/components/responses/Err403" 3516 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3517 "404": 3518 $ref: "#/components/responses/Err404" 3519 description: NOT_FOUND — resource does not exist for this caller. 3520 "429": 3521 $ref: "#/components/responses/Err429" 3522 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3523 "500": 3524 $ref: "#/components/responses/Err500" 3525 description: INTERNAL_ERROR — unexpected server error. 3526 /forms/{formId}/export: 3527 get: 3528 operationId: GetFormsByFormIdExport 3529 tags: 3530 - Forms 3531 summary: Get forms by formId 3532 security: 3533 - bearerAuth: [] 3534 parameters: 3535 - name: formId 3536 in: path 3537 required: true 3538 schema: 3539 type: string 3540 responses: 3541 "200": 3542 description: OK. 3543 content: 3544 application/json: 3545 schema: 3546 type: object 3547 "401": 3548 $ref: "#/components/responses/Err401" 3549 description: UNAUTHORIZED — missing/invalid credentials. 3550 "403": 3551 $ref: "#/components/responses/Err403" 3552 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3553 "404": 3554 $ref: "#/components/responses/Err404" 3555 description: NOT_FOUND — resource does not exist for this caller. 3556 "429": 3557 $ref: "#/components/responses/Err429" 3558 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3559 "500": 3560 $ref: "#/components/responses/Err500" 3561 description: INTERNAL_ERROR — unexpected server error. 3562 /forms/{formId}/questions: 3563 get: 3564 operationId: GetFormsByFormIdQuestions 3565 tags: 3566 - Forms 3567 summary: Get forms by formId 3568 security: 3569 - bearerAuth: [] 3570 parameters: 3571 - name: formId 3572 in: path 3573 required: true 3574 schema: 3575 type: string 3576 responses: 3577 "200": 3578 description: OK. 3579 content: 3580 application/json: 3581 schema: 3582 type: object 3583 "401": 3584 $ref: "#/components/responses/Err401" 3585 description: UNAUTHORIZED — missing/invalid credentials. 3586 "403": 3587 $ref: "#/components/responses/Err403" 3588 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3589 "404": 3590 $ref: "#/components/responses/Err404" 3591 description: NOT_FOUND — resource does not exist for this caller. 3592 "429": 3593 $ref: "#/components/responses/Err429" 3594 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3595 "500": 3596 $ref: "#/components/responses/Err500" 3597 description: INTERNAL_ERROR — unexpected server error. 3598 post: 3599 operationId: PostFormsByFormIdQuestions 3600 tags: 3601 - Forms 3602 summary: Create forms by formId 3603 security: 3604 - bearerAuth: [] 3605 parameters: 3606 - name: formId 3607 in: path 3608 required: true 3609 schema: 3610 type: string 3611 - $ref: "#/components/parameters/IdempotencyKey" 3612 responses: 3613 "201": 3614 description: The created resource. 3615 content: 3616 application/json: 3617 schema: 3618 type: object 3619 "400": 3620 $ref: "#/components/responses/Err400" 3621 description: VALIDATION_ERROR — request validation failed. 3622 "401": 3623 $ref: "#/components/responses/Err401" 3624 description: UNAUTHORIZED — missing/invalid credentials. 3625 "403": 3626 $ref: "#/components/responses/Err403" 3627 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3628 "404": 3629 $ref: "#/components/responses/Err404" 3630 description: NOT_FOUND — resource does not exist for this caller. 3631 "409": 3632 $ref: "#/components/responses/Err409" 3633 description: CONFLICT — duplicate or state conflict. 3634 "429": 3635 $ref: "#/components/responses/Err429" 3636 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3637 "500": 3638 $ref: "#/components/responses/Err500" 3639 description: INTERNAL_ERROR — unexpected server error. 3640 /forms/{formId}/questions/{qid}: 3641 patch: 3642 operationId: PatchFormsByFormIdQuestionsByQid 3643 tags: 3644 - Forms 3645 summary: Update forms by formId + qid 3646 security: 3647 - bearerAuth: [] 3648 parameters: 3649 - name: formId 3650 in: path 3651 required: true 3652 schema: 3653 type: string 3654 - name: qid 3655 in: path 3656 required: true 3657 schema: 3658 type: string 3659 - $ref: "#/components/parameters/IdempotencyKey" 3660 responses: 3661 "200": 3662 description: OK. 3663 content: 3664 application/json: 3665 schema: 3666 type: object 3667 "400": 3668 $ref: "#/components/responses/Err400" 3669 description: VALIDATION_ERROR — request validation failed. 3670 "401": 3671 $ref: "#/components/responses/Err401" 3672 description: UNAUTHORIZED — missing/invalid credentials. 3673 "403": 3674 $ref: "#/components/responses/Err403" 3675 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3676 "404": 3677 $ref: "#/components/responses/Err404" 3678 description: NOT_FOUND — resource does not exist for this caller. 3679 "409": 3680 $ref: "#/components/responses/Err409" 3681 description: CONFLICT — duplicate or state conflict. 3682 "429": 3683 $ref: "#/components/responses/Err429" 3684 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3685 "500": 3686 $ref: "#/components/responses/Err500" 3687 description: INTERNAL_ERROR — unexpected server error. 3688 delete: 3689 operationId: DeleteFormsByFormIdQuestionsByQid 3690 tags: 3691 - Forms 3692 summary: Delete forms by formId + qid 3693 security: 3694 - bearerAuth: [] 3695 parameters: 3696 - name: formId 3697 in: path 3698 required: true 3699 schema: 3700 type: string 3701 - name: qid 3702 in: path 3703 required: true 3704 schema: 3705 type: string 3706 - $ref: "#/components/parameters/IdempotencyKey" 3707 responses: 3708 "200": 3709 description: OK. 3710 content: 3711 application/json: 3712 schema: 3713 type: object 3714 "400": 3715 $ref: "#/components/responses/Err400" 3716 description: VALIDATION_ERROR — request validation failed. 3717 "401": 3718 $ref: "#/components/responses/Err401" 3719 description: UNAUTHORIZED — missing/invalid credentials. 3720 "403": 3721 $ref: "#/components/responses/Err403" 3722 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3723 "404": 3724 $ref: "#/components/responses/Err404" 3725 description: NOT_FOUND — resource does not exist for this caller. 3726 "429": 3727 $ref: "#/components/responses/Err429" 3728 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3729 "500": 3730 $ref: "#/components/responses/Err500" 3731 description: INTERNAL_ERROR — unexpected server error. 3732 /forms/{formId}/questions/reorder: 3733 post: 3734 operationId: PostFormsByFormIdQuestionsReorder 3735 tags: 3736 - Forms 3737 summary: Create forms by formId 3738 security: 3739 - bearerAuth: [] 3740 parameters: 3741 - name: formId 3742 in: path 3743 required: true 3744 schema: 3745 type: string 3746 - $ref: "#/components/parameters/IdempotencyKey" 3747 responses: 3748 "200": 3749 description: OK. 3750 content: 3751 application/json: 3752 schema: 3753 type: object 3754 "400": 3755 $ref: "#/components/responses/Err400" 3756 description: VALIDATION_ERROR — request validation failed. 3757 "401": 3758 $ref: "#/components/responses/Err401" 3759 description: UNAUTHORIZED — missing/invalid credentials. 3760 "403": 3761 $ref: "#/components/responses/Err403" 3762 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3763 "404": 3764 $ref: "#/components/responses/Err404" 3765 description: NOT_FOUND — resource does not exist for this caller. 3766 "429": 3767 $ref: "#/components/responses/Err429" 3768 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3769 "500": 3770 $ref: "#/components/responses/Err500" 3771 description: INTERNAL_ERROR — unexpected server error. 3772 /forms/{formId}/submissions: 3773 get: 3774 operationId: GetFormsByFormIdSubmissions 3775 tags: 3776 - Forms 3777 summary: Get forms by formId 3778 security: 3779 - bearerAuth: [] 3780 parameters: 3781 - name: formId 3782 in: path 3783 required: true 3784 schema: 3785 type: string 3786 responses: 3787 "200": 3788 description: OK. 3789 content: 3790 application/json: 3791 schema: 3792 type: object 3793 "401": 3794 $ref: "#/components/responses/Err401" 3795 description: UNAUTHORIZED — missing/invalid credentials. 3796 "403": 3797 $ref: "#/components/responses/Err403" 3798 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3799 "404": 3800 $ref: "#/components/responses/Err404" 3801 description: NOT_FOUND — resource does not exist for this caller. 3802 "429": 3803 $ref: "#/components/responses/Err429" 3804 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3805 "500": 3806 $ref: "#/components/responses/Err500" 3807 description: INTERNAL_ERROR — unexpected server error. 3808 /forms/{formId}/submissions/{submissionId}: 3809 delete: 3810 operationId: DeleteFormsByFormIdSubmissionsBySubmissionId 3811 tags: 3812 - Forms 3813 summary: Delete forms by formId + submissionId 3814 security: 3815 - bearerAuth: [] 3816 parameters: 3817 - name: formId 3818 in: path 3819 required: true 3820 schema: 3821 type: string 3822 - name: submissionId 3823 in: path 3824 required: true 3825 schema: 3826 type: string 3827 - $ref: "#/components/parameters/IdempotencyKey" 3828 responses: 3829 "200": 3830 description: OK. 3831 content: 3832 application/json: 3833 schema: 3834 type: object 3835 "400": 3836 $ref: "#/components/responses/Err400" 3837 description: VALIDATION_ERROR — request validation failed. 3838 "401": 3839 $ref: "#/components/responses/Err401" 3840 description: UNAUTHORIZED — missing/invalid credentials. 3841 "403": 3842 $ref: "#/components/responses/Err403" 3843 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 3844 "404": 3845 $ref: "#/components/responses/Err404" 3846 description: NOT_FOUND — resource does not exist for this caller. 3847 "429": 3848 $ref: "#/components/responses/Err429" 3849 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3850 "500": 3851 $ref: "#/components/responses/Err500" 3852 description: INTERNAL_ERROR — unexpected server error. 3853 /health: 3854 get: 3855 operationId: GetHealth 3856 tags: 3857 - Health 3858 summary: Liveness/readiness probe 3859 security: [] 3860 parameters: [] 3861 responses: 3862 "200": 3863 description: OK. 3864 content: 3865 application/json: 3866 schema: 3867 type: object 3868 "429": 3869 $ref: "#/components/responses/Err429" 3870 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3871 "500": 3872 $ref: "#/components/responses/Err500" 3873 description: INTERNAL_ERROR — unexpected server error. 3874 /health/deep: 3875 get: 3876 operationId: GetHealthDeep 3877 tags: 3878 - Health 3879 summary: Liveness/readiness probe 3880 security: [] 3881 parameters: [] 3882 responses: 3883 "200": 3884 description: OK. 3885 content: 3886 application/json: 3887 schema: 3888 type: object 3889 "429": 3890 $ref: "#/components/responses/Err429" 3891 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3892 "500": 3893 $ref: "#/components/responses/Err500" 3894 description: INTERNAL_ERROR — unexpected server error. 3895 /health/ready: 3896 get: 3897 operationId: GetHealthReady 3898 tags: 3899 - Health 3900 summary: Liveness/readiness probe 3901 security: [] 3902 parameters: [] 3903 responses: 3904 "200": 3905 description: OK. 3906 content: 3907 application/json: 3908 schema: 3909 type: object 3910 "429": 3911 $ref: "#/components/responses/Err429" 3912 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3913 "500": 3914 $ref: "#/components/responses/Err500" 3915 description: INTERNAL_ERROR — unexpected server error. 3916 /notifications: 3917 get: 3918 operationId: GetNotifications 3919 tags: 3920 - Notifications 3921 summary: List notifications 3922 security: 3923 - bearerAuth: [] 3924 parameters: [] 3925 responses: 3926 "200": 3927 description: OK. 3928 content: 3929 application/json: 3930 schema: 3931 type: object 3932 "401": 3933 $ref: "#/components/responses/Err401" 3934 description: UNAUTHORIZED — missing/invalid credentials. 3935 "429": 3936 $ref: "#/components/responses/Err429" 3937 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3938 "500": 3939 $ref: "#/components/responses/Err500" 3940 description: INTERNAL_ERROR — unexpected server error. 3941 /notifications/{id}/read: 3942 post: 3943 operationId: PostNotificationsByIdRead 3944 tags: 3945 - Notifications 3946 summary: Create notifications by id 3947 security: 3948 - bearerAuth: [] 3949 parameters: 3950 - name: id 3951 in: path 3952 required: true 3953 schema: 3954 type: string 3955 - $ref: "#/components/parameters/IdempotencyKey" 3956 responses: 3957 "200": 3958 description: OK. 3959 content: 3960 application/json: 3961 schema: 3962 type: object 3963 "400": 3964 $ref: "#/components/responses/Err400" 3965 description: VALIDATION_ERROR — request validation failed. 3966 "401": 3967 $ref: "#/components/responses/Err401" 3968 description: UNAUTHORIZED — missing/invalid credentials. 3969 "429": 3970 $ref: "#/components/responses/Err429" 3971 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3972 "500": 3973 $ref: "#/components/responses/Err500" 3974 description: INTERNAL_ERROR — unexpected server error. 3975 /notifications/preferences: 3976 get: 3977 operationId: GetNotificationsPreferences 3978 tags: 3979 - Notifications 3980 summary: List notifications 3981 security: 3982 - bearerAuth: [] 3983 parameters: [] 3984 responses: 3985 "200": 3986 description: OK. 3987 content: 3988 application/json: 3989 schema: 3990 type: object 3991 "401": 3992 $ref: "#/components/responses/Err401" 3993 description: UNAUTHORIZED — missing/invalid credentials. 3994 "429": 3995 $ref: "#/components/responses/Err429" 3996 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 3997 "500": 3998 $ref: "#/components/responses/Err500" 3999 description: INTERNAL_ERROR — unexpected server error. 4000 patch: 4001 operationId: PatchNotificationsPreferences 4002 tags: 4003 - Notifications 4004 summary: Update notifications 4005 security: 4006 - bearerAuth: [] 4007 parameters: 4008 - $ref: "#/components/parameters/IdempotencyKey" 4009 responses: 4010 "200": 4011 description: OK. 4012 content: 4013 application/json: 4014 schema: 4015 type: object 4016 "400": 4017 $ref: "#/components/responses/Err400" 4018 description: VALIDATION_ERROR — request validation failed. 4019 "401": 4020 $ref: "#/components/responses/Err401" 4021 description: UNAUTHORIZED — missing/invalid credentials. 4022 "409": 4023 $ref: "#/components/responses/Err409" 4024 description: CONFLICT — duplicate or state conflict. 4025 "429": 4026 $ref: "#/components/responses/Err429" 4027 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4028 "500": 4029 $ref: "#/components/responses/Err500" 4030 description: INTERNAL_ERROR — unexpected server error. 4031 /notifications/read-all: 4032 post: 4033 operationId: PostNotificationsReadAll 4034 tags: 4035 - Notifications 4036 summary: Mark all notifications read 4037 security: 4038 - bearerAuth: [] 4039 parameters: 4040 - $ref: "#/components/parameters/IdempotencyKey" 4041 responses: 4042 "200": 4043 description: OK. 4044 content: 4045 application/json: 4046 schema: 4047 type: object 4048 "400": 4049 $ref: "#/components/responses/Err400" 4050 description: VALIDATION_ERROR — request validation failed. 4051 "401": 4052 $ref: "#/components/responses/Err401" 4053 description: UNAUTHORIZED — missing/invalid credentials. 4054 "429": 4055 $ref: "#/components/responses/Err429" 4056 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4057 "500": 4058 $ref: "#/components/responses/Err500" 4059 description: INTERNAL_ERROR — unexpected server error. 4060 /notifications/unread-count: 4061 get: 4062 operationId: GetNotificationsUnreadCount 4063 tags: 4064 - Notifications 4065 summary: Get the unread notification count 4066 security: 4067 - bearerAuth: [] 4068 parameters: [] 4069 responses: 4070 "200": 4071 description: OK. 4072 content: 4073 application/json: 4074 schema: 4075 type: object 4076 "401": 4077 $ref: "#/components/responses/Err401" 4078 description: UNAUTHORIZED — missing/invalid credentials. 4079 "429": 4080 $ref: "#/components/responses/Err429" 4081 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4082 "500": 4083 $ref: "#/components/responses/Err500" 4084 description: INTERNAL_ERROR — unexpected server error. 4085 /oauth/authorize: 4086 get: 4087 operationId: GetOauthAuthorize 4088 tags: 4089 - OAuth2 4090 summary: List oauth2 4091 security: 4092 - bearerAuth: [] 4093 parameters: [] 4094 responses: 4095 "200": 4096 description: OK. 4097 content: 4098 application/json: 4099 schema: 4100 type: object 4101 "401": 4102 $ref: "#/components/responses/Err401" 4103 description: UNAUTHORIZED — missing/invalid credentials. 4104 "403": 4105 $ref: "#/components/responses/Err403" 4106 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4107 "404": 4108 $ref: "#/components/responses/Err404" 4109 description: NOT_FOUND — resource does not exist for this caller. 4110 "429": 4111 $ref: "#/components/responses/Err429" 4112 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4113 "500": 4114 $ref: "#/components/responses/Err500" 4115 description: INTERNAL_ERROR — unexpected server error. 4116 post: 4117 operationId: PostOauthAuthorize 4118 tags: 4119 - OAuth2 4120 summary: Create oauth2 4121 security: 4122 - bearerAuth: [] 4123 parameters: 4124 - $ref: "#/components/parameters/IdempotencyKey" 4125 responses: 4126 "200": 4127 description: OK. 4128 content: 4129 application/json: 4130 schema: 4131 type: object 4132 "400": 4133 $ref: "#/components/responses/Err400" 4134 description: VALIDATION_ERROR — request validation failed. 4135 "401": 4136 $ref: "#/components/responses/Err401" 4137 description: UNAUTHORIZED — missing/invalid credentials. 4138 "403": 4139 $ref: "#/components/responses/Err403" 4140 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4141 "404": 4142 $ref: "#/components/responses/Err404" 4143 description: NOT_FOUND — resource does not exist for this caller. 4144 "429": 4145 $ref: "#/components/responses/Err429" 4146 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4147 "500": 4148 $ref: "#/components/responses/Err500" 4149 description: INTERNAL_ERROR — unexpected server error. 4150 /oauth/clients/{clientId}: 4151 get: 4152 operationId: GetOauthClientsByClientId 4153 tags: 4154 - OAuth2 4155 summary: Get oauth2 by clientId 4156 security: 4157 - bearerAuth: [] 4158 parameters: 4159 - name: clientId 4160 in: path 4161 required: true 4162 schema: 4163 type: string 4164 responses: 4165 "200": 4166 description: OK. 4167 content: 4168 application/json: 4169 schema: 4170 type: object 4171 "401": 4172 $ref: "#/components/responses/Err401" 4173 description: UNAUTHORIZED — missing/invalid credentials. 4174 "403": 4175 $ref: "#/components/responses/Err403" 4176 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4177 "404": 4178 $ref: "#/components/responses/Err404" 4179 description: NOT_FOUND — resource does not exist for this caller. 4180 "429": 4181 $ref: "#/components/responses/Err429" 4182 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4183 "500": 4184 $ref: "#/components/responses/Err500" 4185 description: INTERNAL_ERROR — unexpected server error. 4186 /oauth/revoke: 4187 post: 4188 operationId: PostOauthRevoke 4189 tags: 4190 - OAuth2 4191 summary: Create oauth2 4192 security: 4193 - bearerAuth: [] 4194 parameters: 4195 - $ref: "#/components/parameters/IdempotencyKey" 4196 responses: 4197 "200": 4198 description: OK. 4199 content: 4200 application/json: 4201 schema: 4202 type: object 4203 "400": 4204 $ref: "#/components/responses/Err400" 4205 description: VALIDATION_ERROR — request validation failed. 4206 "401": 4207 $ref: "#/components/responses/Err401" 4208 description: UNAUTHORIZED — missing/invalid credentials. 4209 "403": 4210 $ref: "#/components/responses/Err403" 4211 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4212 "404": 4213 $ref: "#/components/responses/Err404" 4214 description: NOT_FOUND — resource does not exist for this caller. 4215 "429": 4216 $ref: "#/components/responses/Err429" 4217 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4218 "500": 4219 $ref: "#/components/responses/Err500" 4220 description: INTERNAL_ERROR — unexpected server error. 4221 /oauth/token: 4222 post: 4223 operationId: PostOauthToken 4224 tags: 4225 - OAuth2 4226 summary: Create oauth2 4227 security: 4228 - bearerAuth: [] 4229 parameters: 4230 - $ref: "#/components/parameters/IdempotencyKey" 4231 responses: 4232 "200": 4233 description: OK. 4234 content: 4235 application/json: 4236 schema: 4237 type: object 4238 "400": 4239 $ref: "#/components/responses/Err400" 4240 description: VALIDATION_ERROR — request validation failed. 4241 "401": 4242 $ref: "#/components/responses/Err401" 4243 description: UNAUTHORIZED — missing/invalid credentials. 4244 "403": 4245 $ref: "#/components/responses/Err403" 4246 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4247 "404": 4248 $ref: "#/components/responses/Err404" 4249 description: NOT_FOUND — resource does not exist for this caller. 4250 "429": 4251 $ref: "#/components/responses/Err429" 4252 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4253 "500": 4254 $ref: "#/components/responses/Err500" 4255 description: INTERNAL_ERROR — unexpected server error. 4256 /orgs: 4257 get: 4258 operationId: GetOrgs 4259 tags: 4260 - Orgs 4261 summary: List the caller's organizations 4262 security: 4263 - bearerAuth: [] 4264 parameters: [] 4265 responses: 4266 "200": 4267 description: OK. 4268 content: 4269 application/json: 4270 schema: 4271 type: object 4272 "401": 4273 $ref: "#/components/responses/Err401" 4274 description: UNAUTHORIZED — missing/invalid credentials. 4275 "429": 4276 $ref: "#/components/responses/Err429" 4277 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4278 "500": 4279 $ref: "#/components/responses/Err500" 4280 description: INTERNAL_ERROR — unexpected server error. 4281 post: 4282 operationId: PostOrgs 4283 tags: 4284 - Orgs 4285 summary: Create an organization 4286 security: 4287 - bearerAuth: [] 4288 parameters: 4289 - $ref: "#/components/parameters/IdempotencyKey" 4290 responses: 4291 "201": 4292 description: The created resource. 4293 content: 4294 application/json: 4295 schema: 4296 type: object 4297 "400": 4298 $ref: "#/components/responses/Err400" 4299 description: VALIDATION_ERROR — request validation failed. 4300 "401": 4301 $ref: "#/components/responses/Err401" 4302 description: UNAUTHORIZED — missing/invalid credentials. 4303 "409": 4304 $ref: "#/components/responses/Err409" 4305 description: CONFLICT — duplicate or state conflict. 4306 "429": 4307 $ref: "#/components/responses/Err429" 4308 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4309 "500": 4310 $ref: "#/components/responses/Err500" 4311 description: INTERNAL_ERROR — unexpected server error. 4312 /orgs/{id}: 4313 get: 4314 operationId: GetOrgsById 4315 tags: 4316 - Orgs 4317 summary: Get orgs by id 4318 security: 4319 - bearerAuth: [] 4320 parameters: 4321 - name: id 4322 in: path 4323 required: true 4324 schema: 4325 type: string 4326 responses: 4327 "200": 4328 description: OK. 4329 content: 4330 application/json: 4331 schema: 4332 type: object 4333 "401": 4334 $ref: "#/components/responses/Err401" 4335 description: UNAUTHORIZED — missing/invalid credentials. 4336 "429": 4337 $ref: "#/components/responses/Err429" 4338 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4339 "500": 4340 $ref: "#/components/responses/Err500" 4341 description: INTERNAL_ERROR — unexpected server error. 4342 patch: 4343 operationId: PatchOrgsById 4344 tags: 4345 - Orgs 4346 summary: Update orgs by id 4347 security: 4348 - bearerAuth: [] 4349 parameters: 4350 - name: id 4351 in: path 4352 required: true 4353 schema: 4354 type: string 4355 - $ref: "#/components/parameters/IdempotencyKey" 4356 responses: 4357 "200": 4358 description: OK. 4359 content: 4360 application/json: 4361 schema: 4362 type: object 4363 "400": 4364 $ref: "#/components/responses/Err400" 4365 description: VALIDATION_ERROR — request validation failed. 4366 "401": 4367 $ref: "#/components/responses/Err401" 4368 description: UNAUTHORIZED — missing/invalid credentials. 4369 "409": 4370 $ref: "#/components/responses/Err409" 4371 description: CONFLICT — duplicate or state conflict. 4372 "429": 4373 $ref: "#/components/responses/Err429" 4374 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4375 "500": 4376 $ref: "#/components/responses/Err500" 4377 description: INTERNAL_ERROR — unexpected server error. 4378 /orgs/{id}/members/invites: 4379 post: 4380 operationId: PostOrgsByIdMembersInvites 4381 tags: 4382 - Orgs 4383 summary: Create orgs by id 4384 security: 4385 - bearerAuth: [] 4386 parameters: 4387 - name: id 4388 in: path 4389 required: true 4390 schema: 4391 type: string 4392 - $ref: "#/components/parameters/IdempotencyKey" 4393 responses: 4394 "200": 4395 description: OK. 4396 content: 4397 application/json: 4398 schema: 4399 type: object 4400 "400": 4401 $ref: "#/components/responses/Err400" 4402 description: VALIDATION_ERROR — request validation failed. 4403 "401": 4404 $ref: "#/components/responses/Err401" 4405 description: UNAUTHORIZED — missing/invalid credentials. 4406 "429": 4407 $ref: "#/components/responses/Err429" 4408 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4409 "500": 4410 $ref: "#/components/responses/Err500" 4411 description: INTERNAL_ERROR — unexpected server error. 4412 /orgs/{orgId}/admin/analytics: 4413 get: 4414 operationId: GetOrgsByOrgIdAdminAnalytics 4415 tags: 4416 - Orgs 4417 summary: Get orgs by orgId 4418 security: 4419 - bearerAuth: [] 4420 parameters: 4421 - name: orgId 4422 in: path 4423 required: true 4424 schema: 4425 type: string 4426 responses: 4427 "200": 4428 description: OK. 4429 content: 4430 application/json: 4431 schema: 4432 type: object 4433 "401": 4434 $ref: "#/components/responses/Err401" 4435 description: UNAUTHORIZED — missing/invalid credentials. 4436 "403": 4437 $ref: "#/components/responses/Err403" 4438 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4439 "404": 4440 $ref: "#/components/responses/Err404" 4441 description: NOT_FOUND — resource does not exist for this caller. 4442 "429": 4443 $ref: "#/components/responses/Err429" 4444 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4445 "500": 4446 $ref: "#/components/responses/Err500" 4447 description: INTERNAL_ERROR — unexpected server error. 4448 /orgs/{orgId}/admin/audit: 4449 get: 4450 operationId: GetOrgsByOrgIdAdminAudit 4451 tags: 4452 - Orgs 4453 summary: Get orgs by orgId 4454 security: 4455 - bearerAuth: [] 4456 parameters: 4457 - name: orgId 4458 in: path 4459 required: true 4460 schema: 4461 type: string 4462 responses: 4463 "200": 4464 description: OK. 4465 content: 4466 application/json: 4467 schema: 4468 type: object 4469 "401": 4470 $ref: "#/components/responses/Err401" 4471 description: UNAUTHORIZED — missing/invalid credentials. 4472 "403": 4473 $ref: "#/components/responses/Err403" 4474 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4475 "404": 4476 $ref: "#/components/responses/Err404" 4477 description: NOT_FOUND — resource does not exist for this caller. 4478 "429": 4479 $ref: "#/components/responses/Err429" 4480 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4481 "500": 4482 $ref: "#/components/responses/Err500" 4483 description: INTERNAL_ERROR — unexpected server error. 4484 /orgs/{orgId}/admin/audit/actions: 4485 get: 4486 operationId: GetOrgsByOrgIdAdminAuditActions 4487 tags: 4488 - Orgs 4489 summary: Get orgs by orgId 4490 security: 4491 - bearerAuth: [] 4492 parameters: 4493 - name: orgId 4494 in: path 4495 required: true 4496 schema: 4497 type: string 4498 responses: 4499 "200": 4500 description: OK. 4501 content: 4502 application/json: 4503 schema: 4504 type: object 4505 "401": 4506 $ref: "#/components/responses/Err401" 4507 description: UNAUTHORIZED — missing/invalid credentials. 4508 "403": 4509 $ref: "#/components/responses/Err403" 4510 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4511 "404": 4512 $ref: "#/components/responses/Err404" 4513 description: NOT_FOUND — resource does not exist for this caller. 4514 "429": 4515 $ref: "#/components/responses/Err429" 4516 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4517 "500": 4518 $ref: "#/components/responses/Err500" 4519 description: INTERNAL_ERROR — unexpected server error. 4520 /orgs/{orgId}/admin/audit/export: 4521 post: 4522 operationId: PostOrgsByOrgIdAdminAuditExport 4523 tags: 4524 - Orgs 4525 summary: Create orgs by orgId 4526 security: 4527 - bearerAuth: [] 4528 parameters: 4529 - name: orgId 4530 in: path 4531 required: true 4532 schema: 4533 type: string 4534 - $ref: "#/components/parameters/IdempotencyKey" 4535 responses: 4536 "200": 4537 description: OK. 4538 content: 4539 application/json: 4540 schema: 4541 type: object 4542 "400": 4543 $ref: "#/components/responses/Err400" 4544 description: VALIDATION_ERROR — request validation failed. 4545 "401": 4546 $ref: "#/components/responses/Err401" 4547 description: UNAUTHORIZED — missing/invalid credentials. 4548 "403": 4549 $ref: "#/components/responses/Err403" 4550 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4551 "404": 4552 $ref: "#/components/responses/Err404" 4553 description: NOT_FOUND — resource does not exist for this caller. 4554 "429": 4555 $ref: "#/components/responses/Err429" 4556 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4557 "500": 4558 $ref: "#/components/responses/Err500" 4559 description: INTERNAL_ERROR — unexpected server error. 4560 /orgs/{orgId}/admin/audit/exports/{exportId}: 4561 get: 4562 operationId: GetOrgsByOrgIdAdminAuditExportsByExportId 4563 tags: 4564 - Orgs 4565 summary: Get orgs by orgId + exportId 4566 security: 4567 - bearerAuth: [] 4568 parameters: 4569 - name: orgId 4570 in: path 4571 required: true 4572 schema: 4573 type: string 4574 - name: exportId 4575 in: path 4576 required: true 4577 schema: 4578 type: string 4579 responses: 4580 "200": 4581 description: OK. 4582 content: 4583 application/json: 4584 schema: 4585 type: object 4586 "401": 4587 $ref: "#/components/responses/Err401" 4588 description: UNAUTHORIZED — missing/invalid credentials. 4589 "403": 4590 $ref: "#/components/responses/Err403" 4591 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4592 "404": 4593 $ref: "#/components/responses/Err404" 4594 description: NOT_FOUND — resource does not exist for this caller. 4595 "429": 4596 $ref: "#/components/responses/Err429" 4597 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4598 "500": 4599 $ref: "#/components/responses/Err500" 4600 description: INTERNAL_ERROR — unexpected server error. 4601 /orgs/{orgId}/admin/jobs: 4602 get: 4603 operationId: GetOrgsByOrgIdAdminJobs 4604 tags: 4605 - Orgs 4606 summary: Get orgs by orgId 4607 security: 4608 - bearerAuth: [] 4609 parameters: 4610 - name: orgId 4611 in: path 4612 required: true 4613 schema: 4614 type: string 4615 responses: 4616 "200": 4617 description: OK. 4618 content: 4619 application/json: 4620 schema: 4621 type: object 4622 "401": 4623 $ref: "#/components/responses/Err401" 4624 description: UNAUTHORIZED — missing/invalid credentials. 4625 "403": 4626 $ref: "#/components/responses/Err403" 4627 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4628 "404": 4629 $ref: "#/components/responses/Err404" 4630 description: NOT_FOUND — resource does not exist for this caller. 4631 "429": 4632 $ref: "#/components/responses/Err429" 4633 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4634 "500": 4635 $ref: "#/components/responses/Err500" 4636 description: INTERNAL_ERROR — unexpected server error. 4637 /orgs/{orgId}/admin/jobs/failed: 4638 get: 4639 operationId: GetOrgsByOrgIdAdminJobsFailed 4640 tags: 4641 - Orgs 4642 summary: Get orgs by orgId 4643 security: 4644 - bearerAuth: [] 4645 parameters: 4646 - name: orgId 4647 in: path 4648 required: true 4649 schema: 4650 type: string 4651 responses: 4652 "200": 4653 description: OK. 4654 content: 4655 application/json: 4656 schema: 4657 type: object 4658 "401": 4659 $ref: "#/components/responses/Err401" 4660 description: UNAUTHORIZED — missing/invalid credentials. 4661 "403": 4662 $ref: "#/components/responses/Err403" 4663 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4664 "404": 4665 $ref: "#/components/responses/Err404" 4666 description: NOT_FOUND — resource does not exist for this caller. 4667 "429": 4668 $ref: "#/components/responses/Err429" 4669 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4670 "500": 4671 $ref: "#/components/responses/Err500" 4672 description: INTERNAL_ERROR — unexpected server error. 4673 /orgs/{orgId}/admin/jobs/requeue: 4674 post: 4675 operationId: PostOrgsByOrgIdAdminJobsRequeue 4676 tags: 4677 - Orgs 4678 summary: Create orgs by orgId 4679 security: 4680 - bearerAuth: [] 4681 parameters: 4682 - name: orgId 4683 in: path 4684 required: true 4685 schema: 4686 type: string 4687 - $ref: "#/components/parameters/IdempotencyKey" 4688 responses: 4689 "200": 4690 description: OK. 4691 content: 4692 application/json: 4693 schema: 4694 type: object 4695 "400": 4696 $ref: "#/components/responses/Err400" 4697 description: VALIDATION_ERROR — request validation failed. 4698 "401": 4699 $ref: "#/components/responses/Err401" 4700 description: UNAUTHORIZED — missing/invalid credentials. 4701 "403": 4702 $ref: "#/components/responses/Err403" 4703 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4704 "404": 4705 $ref: "#/components/responses/Err404" 4706 description: NOT_FOUND — resource does not exist for this caller. 4707 "429": 4708 $ref: "#/components/responses/Err429" 4709 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4710 "500": 4711 $ref: "#/components/responses/Err500" 4712 description: INTERNAL_ERROR — unexpected server error. 4713 /orgs/{orgId}/admin/members: 4714 get: 4715 operationId: GetOrgsByOrgIdAdminMembers 4716 tags: 4717 - Orgs 4718 summary: Get orgs by orgId 4719 security: 4720 - bearerAuth: [] 4721 parameters: 4722 - name: orgId 4723 in: path 4724 required: true 4725 schema: 4726 type: string 4727 responses: 4728 "200": 4729 description: OK. 4730 content: 4731 application/json: 4732 schema: 4733 type: object 4734 "401": 4735 $ref: "#/components/responses/Err401" 4736 description: UNAUTHORIZED — missing/invalid credentials. 4737 "403": 4738 $ref: "#/components/responses/Err403" 4739 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4740 "404": 4741 $ref: "#/components/responses/Err404" 4742 description: NOT_FOUND — resource does not exist for this caller. 4743 "429": 4744 $ref: "#/components/responses/Err429" 4745 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4746 "500": 4747 $ref: "#/components/responses/Err500" 4748 description: INTERNAL_ERROR — unexpected server error. 4749 /orgs/{orgId}/admin/members/{userId}: 4750 patch: 4751 operationId: PatchOrgsByOrgIdAdminMembersByUserId 4752 tags: 4753 - Orgs 4754 summary: Update orgs by orgId + userId 4755 security: 4756 - bearerAuth: [] 4757 parameters: 4758 - name: orgId 4759 in: path 4760 required: true 4761 schema: 4762 type: string 4763 - name: userId 4764 in: path 4765 required: true 4766 schema: 4767 type: string 4768 - $ref: "#/components/parameters/IdempotencyKey" 4769 responses: 4770 "200": 4771 description: OK. 4772 content: 4773 application/json: 4774 schema: 4775 type: object 4776 "400": 4777 $ref: "#/components/responses/Err400" 4778 description: VALIDATION_ERROR — request validation failed. 4779 "401": 4780 $ref: "#/components/responses/Err401" 4781 description: UNAUTHORIZED — missing/invalid credentials. 4782 "403": 4783 $ref: "#/components/responses/Err403" 4784 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4785 "404": 4786 $ref: "#/components/responses/Err404" 4787 description: NOT_FOUND — resource does not exist for this caller. 4788 "409": 4789 $ref: "#/components/responses/Err409" 4790 description: CONFLICT — duplicate or state conflict. 4791 "429": 4792 $ref: "#/components/responses/Err429" 4793 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4794 "500": 4795 $ref: "#/components/responses/Err500" 4796 description: INTERNAL_ERROR — unexpected server error. 4797 /orgs/{orgId}/admin/notifications/health: 4798 get: 4799 operationId: GetOrgsByOrgIdAdminNotificationsHealth 4800 tags: 4801 - Orgs 4802 summary: Get orgs by orgId 4803 security: 4804 - bearerAuth: [] 4805 parameters: 4806 - name: orgId 4807 in: path 4808 required: true 4809 schema: 4810 type: string 4811 responses: 4812 "200": 4813 description: OK. 4814 content: 4815 application/json: 4816 schema: 4817 type: object 4818 "401": 4819 $ref: "#/components/responses/Err401" 4820 description: UNAUTHORIZED — missing/invalid credentials. 4821 "403": 4822 $ref: "#/components/responses/Err403" 4823 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4824 "404": 4825 $ref: "#/components/responses/Err404" 4826 description: NOT_FOUND — resource does not exist for this caller. 4827 "429": 4828 $ref: "#/components/responses/Err429" 4829 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4830 "500": 4831 $ref: "#/components/responses/Err500" 4832 description: INTERNAL_ERROR — unexpected server error. 4833 /orgs/{orgId}/admin/overview: 4834 get: 4835 operationId: GetOrgsByOrgIdAdminOverview 4836 tags: 4837 - Orgs 4838 summary: Get orgs by orgId 4839 security: 4840 - bearerAuth: [] 4841 parameters: 4842 - name: orgId 4843 in: path 4844 required: true 4845 schema: 4846 type: string 4847 responses: 4848 "200": 4849 description: OK. 4850 content: 4851 application/json: 4852 schema: 4853 type: object 4854 "401": 4855 $ref: "#/components/responses/Err401" 4856 description: UNAUTHORIZED — missing/invalid credentials. 4857 "403": 4858 $ref: "#/components/responses/Err403" 4859 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4860 "404": 4861 $ref: "#/components/responses/Err404" 4862 description: NOT_FOUND — resource does not exist for this caller. 4863 "429": 4864 $ref: "#/components/responses/Err429" 4865 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4866 "500": 4867 $ref: "#/components/responses/Err500" 4868 description: INTERNAL_ERROR — unexpected server error. 4869 /orgs/{orgId}/admin/policy: 4870 get: 4871 operationId: GetOrgsByOrgIdAdminPolicy 4872 tags: 4873 - Orgs 4874 summary: Get orgs by orgId 4875 security: 4876 - bearerAuth: [] 4877 parameters: 4878 - name: orgId 4879 in: path 4880 required: true 4881 schema: 4882 type: string 4883 responses: 4884 "200": 4885 description: OK. 4886 content: 4887 application/json: 4888 schema: 4889 type: object 4890 "401": 4891 $ref: "#/components/responses/Err401" 4892 description: UNAUTHORIZED — missing/invalid credentials. 4893 "403": 4894 $ref: "#/components/responses/Err403" 4895 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4896 "404": 4897 $ref: "#/components/responses/Err404" 4898 description: NOT_FOUND — resource does not exist for this caller. 4899 "429": 4900 $ref: "#/components/responses/Err429" 4901 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4902 "500": 4903 $ref: "#/components/responses/Err500" 4904 description: INTERNAL_ERROR — unexpected server error. 4905 patch: 4906 operationId: PatchOrgsByOrgIdAdminPolicy 4907 tags: 4908 - Orgs 4909 summary: Update orgs by orgId 4910 security: 4911 - bearerAuth: [] 4912 parameters: 4913 - name: orgId 4914 in: path 4915 required: true 4916 schema: 4917 type: string 4918 - $ref: "#/components/parameters/IdempotencyKey" 4919 responses: 4920 "200": 4921 description: OK. 4922 content: 4923 application/json: 4924 schema: 4925 type: object 4926 "400": 4927 $ref: "#/components/responses/Err400" 4928 description: VALIDATION_ERROR — request validation failed. 4929 "401": 4930 $ref: "#/components/responses/Err401" 4931 description: UNAUTHORIZED — missing/invalid credentials. 4932 "403": 4933 $ref: "#/components/responses/Err403" 4934 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4935 "404": 4936 $ref: "#/components/responses/Err404" 4937 description: NOT_FOUND — resource does not exist for this caller. 4938 "409": 4939 $ref: "#/components/responses/Err409" 4940 description: CONFLICT — duplicate or state conflict. 4941 "429": 4942 $ref: "#/components/responses/Err429" 4943 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4944 "500": 4945 $ref: "#/components/responses/Err500" 4946 description: INTERNAL_ERROR — unexpected server error. 4947 /orgs/{orgId}/admin/retention: 4948 get: 4949 operationId: GetOrgsByOrgIdAdminRetention 4950 tags: 4951 - Orgs 4952 summary: Get orgs by orgId 4953 security: 4954 - bearerAuth: [] 4955 parameters: 4956 - name: orgId 4957 in: path 4958 required: true 4959 schema: 4960 type: string 4961 responses: 4962 "200": 4963 description: OK. 4964 content: 4965 application/json: 4966 schema: 4967 type: object 4968 "401": 4969 $ref: "#/components/responses/Err401" 4970 description: UNAUTHORIZED — missing/invalid credentials. 4971 "403": 4972 $ref: "#/components/responses/Err403" 4973 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 4974 "404": 4975 $ref: "#/components/responses/Err404" 4976 description: NOT_FOUND — resource does not exist for this caller. 4977 "429": 4978 $ref: "#/components/responses/Err429" 4979 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 4980 "500": 4981 $ref: "#/components/responses/Err500" 4982 description: INTERNAL_ERROR — unexpected server error. 4983 patch: 4984 operationId: PatchOrgsByOrgIdAdminRetention 4985 tags: 4986 - Orgs 4987 summary: Update orgs by orgId 4988 security: 4989 - bearerAuth: [] 4990 parameters: 4991 - name: orgId 4992 in: path 4993 required: true 4994 schema: 4995 type: string 4996 - $ref: "#/components/parameters/IdempotencyKey" 4997 responses: 4998 "200": 4999 description: OK. 5000 content: 5001 application/json: 5002 schema: 5003 type: object 5004 "400": 5005 $ref: "#/components/responses/Err400" 5006 description: VALIDATION_ERROR — request validation failed. 5007 "401": 5008 $ref: "#/components/responses/Err401" 5009 description: UNAUTHORIZED — missing/invalid credentials. 5010 "403": 5011 $ref: "#/components/responses/Err403" 5012 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5013 "404": 5014 $ref: "#/components/responses/Err404" 5015 description: NOT_FOUND — resource does not exist for this caller. 5016 "409": 5017 $ref: "#/components/responses/Err409" 5018 description: CONFLICT — duplicate or state conflict. 5019 "429": 5020 $ref: "#/components/responses/Err429" 5021 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5022 "500": 5023 $ref: "#/components/responses/Err500" 5024 description: INTERNAL_ERROR — unexpected server error. 5025 /orgs/{orgId}/admin/retention/run: 5026 post: 5027 operationId: PostOrgsByOrgIdAdminRetentionRun 5028 tags: 5029 - Orgs 5030 summary: Create orgs by orgId 5031 security: 5032 - bearerAuth: [] 5033 parameters: 5034 - name: orgId 5035 in: path 5036 required: true 5037 schema: 5038 type: string 5039 - $ref: "#/components/parameters/IdempotencyKey" 5040 responses: 5041 "200": 5042 description: OK. 5043 content: 5044 application/json: 5045 schema: 5046 type: object 5047 "400": 5048 $ref: "#/components/responses/Err400" 5049 description: VALIDATION_ERROR — request validation failed. 5050 "401": 5051 $ref: "#/components/responses/Err401" 5052 description: UNAUTHORIZED — missing/invalid credentials. 5053 "403": 5054 $ref: "#/components/responses/Err403" 5055 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5056 "404": 5057 $ref: "#/components/responses/Err404" 5058 description: NOT_FOUND — resource does not exist for this caller. 5059 "429": 5060 $ref: "#/components/responses/Err429" 5061 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5062 "500": 5063 $ref: "#/components/responses/Err500" 5064 description: INTERNAL_ERROR — unexpected server error. 5065 /orgs/{orgId}/admin/retention/runs/{runId}: 5066 get: 5067 operationId: GetOrgsByOrgIdAdminRetentionRunsByRunId 5068 tags: 5069 - Orgs 5070 summary: Get orgs by orgId + runId 5071 security: 5072 - bearerAuth: [] 5073 parameters: 5074 - name: orgId 5075 in: path 5076 required: true 5077 schema: 5078 type: string 5079 - name: runId 5080 in: path 5081 required: true 5082 schema: 5083 type: string 5084 responses: 5085 "200": 5086 description: OK. 5087 content: 5088 application/json: 5089 schema: 5090 type: object 5091 "401": 5092 $ref: "#/components/responses/Err401" 5093 description: UNAUTHORIZED — missing/invalid credentials. 5094 "403": 5095 $ref: "#/components/responses/Err403" 5096 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5097 "404": 5098 $ref: "#/components/responses/Err404" 5099 description: NOT_FOUND — resource does not exist for this caller. 5100 "429": 5101 $ref: "#/components/responses/Err429" 5102 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5103 "500": 5104 $ref: "#/components/responses/Err500" 5105 description: INTERNAL_ERROR — unexpected server error. 5106 /orgs/{orgId}/admin/search/health: 5107 get: 5108 operationId: GetOrgsByOrgIdAdminSearchHealth 5109 tags: 5110 - Orgs 5111 summary: Get orgs by orgId 5112 security: 5113 - bearerAuth: [] 5114 parameters: 5115 - name: orgId 5116 in: path 5117 required: true 5118 schema: 5119 type: string 5120 responses: 5121 "200": 5122 description: OK. 5123 content: 5124 application/json: 5125 schema: 5126 type: object 5127 "401": 5128 $ref: "#/components/responses/Err401" 5129 description: UNAUTHORIZED — missing/invalid credentials. 5130 "403": 5131 $ref: "#/components/responses/Err403" 5132 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5133 "404": 5134 $ref: "#/components/responses/Err404" 5135 description: NOT_FOUND — resource does not exist for this caller. 5136 "429": 5137 $ref: "#/components/responses/Err429" 5138 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5139 "500": 5140 $ref: "#/components/responses/Err500" 5141 description: INTERNAL_ERROR — unexpected server error. 5142 /orgs/{orgId}/admin/search/reindex: 5143 post: 5144 operationId: PostOrgsByOrgIdAdminSearchReindex 5145 tags: 5146 - Orgs 5147 summary: Create orgs by orgId 5148 security: 5149 - bearerAuth: [] 5150 parameters: 5151 - name: orgId 5152 in: path 5153 required: true 5154 schema: 5155 type: string 5156 - $ref: "#/components/parameters/IdempotencyKey" 5157 responses: 5158 "200": 5159 description: OK. 5160 content: 5161 application/json: 5162 schema: 5163 type: object 5164 "400": 5165 $ref: "#/components/responses/Err400" 5166 description: VALIDATION_ERROR — request validation failed. 5167 "401": 5168 $ref: "#/components/responses/Err401" 5169 description: UNAUTHORIZED — missing/invalid credentials. 5170 "403": 5171 $ref: "#/components/responses/Err403" 5172 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5173 "404": 5174 $ref: "#/components/responses/Err404" 5175 description: NOT_FOUND — resource does not exist for this caller. 5176 "429": 5177 $ref: "#/components/responses/Err429" 5178 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5179 "500": 5180 $ref: "#/components/responses/Err500" 5181 description: INTERNAL_ERROR — unexpected server error. 5182 /orgs/{orgId}/admin/workspaces: 5183 get: 5184 operationId: GetOrgsByOrgIdAdminWorkspaces 5185 tags: 5186 - Orgs 5187 summary: Get orgs by orgId 5188 security: 5189 - bearerAuth: [] 5190 parameters: 5191 - name: orgId 5192 in: path 5193 required: true 5194 schema: 5195 type: string 5196 responses: 5197 "200": 5198 description: OK. 5199 content: 5200 application/json: 5201 schema: 5202 type: object 5203 "401": 5204 $ref: "#/components/responses/Err401" 5205 description: UNAUTHORIZED — missing/invalid credentials. 5206 "403": 5207 $ref: "#/components/responses/Err403" 5208 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5209 "404": 5210 $ref: "#/components/responses/Err404" 5211 description: NOT_FOUND — resource does not exist for this caller. 5212 "429": 5213 $ref: "#/components/responses/Err429" 5214 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5215 "500": 5216 $ref: "#/components/responses/Err500" 5217 description: INTERNAL_ERROR — unexpected server error. 5218 /orgs/{orgId}/scim: 5219 get: 5220 operationId: GetOrgsByOrgIdScim 5221 tags: 5222 - Orgs 5223 summary: Get orgs by orgId 5224 security: 5225 - bearerAuth: [] 5226 parameters: 5227 - name: orgId 5228 in: path 5229 required: true 5230 schema: 5231 type: string 5232 responses: 5233 "200": 5234 description: OK. 5235 content: 5236 application/json: 5237 schema: 5238 type: object 5239 "401": 5240 $ref: "#/components/responses/Err401" 5241 description: UNAUTHORIZED — missing/invalid credentials. 5242 "403": 5243 $ref: "#/components/responses/Err403" 5244 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5245 "404": 5246 $ref: "#/components/responses/Err404" 5247 description: NOT_FOUND — resource does not exist for this caller. 5248 "429": 5249 $ref: "#/components/responses/Err429" 5250 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5251 "500": 5252 $ref: "#/components/responses/Err500" 5253 description: INTERNAL_ERROR — unexpected server error. 5254 post: 5255 operationId: PostOrgsByOrgIdScim 5256 tags: 5257 - Orgs 5258 summary: Create orgs by orgId 5259 security: 5260 - bearerAuth: [] 5261 parameters: 5262 - name: orgId 5263 in: path 5264 required: true 5265 schema: 5266 type: string 5267 - $ref: "#/components/parameters/IdempotencyKey" 5268 responses: 5269 "200": 5270 description: OK. 5271 content: 5272 application/json: 5273 schema: 5274 type: object 5275 "400": 5276 $ref: "#/components/responses/Err400" 5277 description: VALIDATION_ERROR — request validation failed. 5278 "401": 5279 $ref: "#/components/responses/Err401" 5280 description: UNAUTHORIZED — missing/invalid credentials. 5281 "403": 5282 $ref: "#/components/responses/Err403" 5283 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5284 "404": 5285 $ref: "#/components/responses/Err404" 5286 description: NOT_FOUND — resource does not exist for this caller. 5287 "429": 5288 $ref: "#/components/responses/Err429" 5289 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5290 "500": 5291 $ref: "#/components/responses/Err500" 5292 description: INTERNAL_ERROR — unexpected server error. 5293 patch: 5294 operationId: PatchOrgsByOrgIdScim 5295 tags: 5296 - Orgs 5297 summary: Update orgs by orgId 5298 security: 5299 - bearerAuth: [] 5300 parameters: 5301 - name: orgId 5302 in: path 5303 required: true 5304 schema: 5305 type: string 5306 - $ref: "#/components/parameters/IdempotencyKey" 5307 responses: 5308 "200": 5309 description: OK. 5310 content: 5311 application/json: 5312 schema: 5313 type: object 5314 "400": 5315 $ref: "#/components/responses/Err400" 5316 description: VALIDATION_ERROR — request validation failed. 5317 "401": 5318 $ref: "#/components/responses/Err401" 5319 description: UNAUTHORIZED — missing/invalid credentials. 5320 "403": 5321 $ref: "#/components/responses/Err403" 5322 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5323 "404": 5324 $ref: "#/components/responses/Err404" 5325 description: NOT_FOUND — resource does not exist for this caller. 5326 "409": 5327 $ref: "#/components/responses/Err409" 5328 description: CONFLICT — duplicate or state conflict. 5329 "429": 5330 $ref: "#/components/responses/Err429" 5331 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5332 "500": 5333 $ref: "#/components/responses/Err500" 5334 description: INTERNAL_ERROR — unexpected server error. 5335 /orgs/{orgId}/scim/test: 5336 post: 5337 operationId: PostOrgsByOrgIdScimTest 5338 tags: 5339 - Orgs 5340 summary: Create orgs by orgId 5341 security: 5342 - bearerAuth: [] 5343 parameters: 5344 - name: orgId 5345 in: path 5346 required: true 5347 schema: 5348 type: string 5349 - $ref: "#/components/parameters/IdempotencyKey" 5350 responses: 5351 "200": 5352 description: OK. 5353 content: 5354 application/json: 5355 schema: 5356 type: object 5357 "400": 5358 $ref: "#/components/responses/Err400" 5359 description: VALIDATION_ERROR — request validation failed. 5360 "401": 5361 $ref: "#/components/responses/Err401" 5362 description: UNAUTHORIZED — missing/invalid credentials. 5363 "403": 5364 $ref: "#/components/responses/Err403" 5365 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5366 "404": 5367 $ref: "#/components/responses/Err404" 5368 description: NOT_FOUND — resource does not exist for this caller. 5369 "429": 5370 $ref: "#/components/responses/Err429" 5371 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5372 "500": 5373 $ref: "#/components/responses/Err500" 5374 description: INTERNAL_ERROR — unexpected server error. 5375 /orgs/{orgId}/sso: 5376 get: 5377 operationId: GetOrgsByOrgIdSso 5378 tags: 5379 - Orgs 5380 summary: Get orgs by orgId 5381 security: 5382 - bearerAuth: [] 5383 parameters: 5384 - name: orgId 5385 in: path 5386 required: true 5387 schema: 5388 type: string 5389 responses: 5390 "200": 5391 description: OK. 5392 content: 5393 application/json: 5394 schema: 5395 type: object 5396 "401": 5397 $ref: "#/components/responses/Err401" 5398 description: UNAUTHORIZED — missing/invalid credentials. 5399 "403": 5400 $ref: "#/components/responses/Err403" 5401 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5402 "404": 5403 $ref: "#/components/responses/Err404" 5404 description: NOT_FOUND — resource does not exist for this caller. 5405 "429": 5406 $ref: "#/components/responses/Err429" 5407 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5408 "500": 5409 $ref: "#/components/responses/Err500" 5410 description: INTERNAL_ERROR — unexpected server error. 5411 post: 5412 operationId: PostOrgsByOrgIdSso 5413 tags: 5414 - Orgs 5415 summary: Create orgs by orgId 5416 security: 5417 - bearerAuth: [] 5418 parameters: 5419 - name: orgId 5420 in: path 5421 required: true 5422 schema: 5423 type: string 5424 - $ref: "#/components/parameters/IdempotencyKey" 5425 responses: 5426 "200": 5427 description: OK. 5428 content: 5429 application/json: 5430 schema: 5431 type: object 5432 "400": 5433 $ref: "#/components/responses/Err400" 5434 description: VALIDATION_ERROR — request validation failed. 5435 "401": 5436 $ref: "#/components/responses/Err401" 5437 description: UNAUTHORIZED — missing/invalid credentials. 5438 "403": 5439 $ref: "#/components/responses/Err403" 5440 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5441 "404": 5442 $ref: "#/components/responses/Err404" 5443 description: NOT_FOUND — resource does not exist for this caller. 5444 "429": 5445 $ref: "#/components/responses/Err429" 5446 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5447 "500": 5448 $ref: "#/components/responses/Err500" 5449 description: INTERNAL_ERROR — unexpected server error. 5450 patch: 5451 operationId: PatchOrgsByOrgIdSso 5452 tags: 5453 - Orgs 5454 summary: Update orgs by orgId 5455 security: 5456 - bearerAuth: [] 5457 parameters: 5458 - name: orgId 5459 in: path 5460 required: true 5461 schema: 5462 type: string 5463 - $ref: "#/components/parameters/IdempotencyKey" 5464 responses: 5465 "200": 5466 description: OK. 5467 content: 5468 application/json: 5469 schema: 5470 type: object 5471 "400": 5472 $ref: "#/components/responses/Err400" 5473 description: VALIDATION_ERROR — request validation failed. 5474 "401": 5475 $ref: "#/components/responses/Err401" 5476 description: UNAUTHORIZED — missing/invalid credentials. 5477 "403": 5478 $ref: "#/components/responses/Err403" 5479 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5480 "404": 5481 $ref: "#/components/responses/Err404" 5482 description: NOT_FOUND — resource does not exist for this caller. 5483 "409": 5484 $ref: "#/components/responses/Err409" 5485 description: CONFLICT — duplicate or state conflict. 5486 "429": 5487 $ref: "#/components/responses/Err429" 5488 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5489 "500": 5490 $ref: "#/components/responses/Err500" 5491 description: INTERNAL_ERROR — unexpected server error. 5492 delete: 5493 operationId: DeleteOrgsByOrgIdSso 5494 tags: 5495 - Orgs 5496 summary: Delete orgs by orgId 5497 security: 5498 - bearerAuth: [] 5499 parameters: 5500 - name: orgId 5501 in: path 5502 required: true 5503 schema: 5504 type: string 5505 - $ref: "#/components/parameters/IdempotencyKey" 5506 responses: 5507 "200": 5508 description: OK. 5509 content: 5510 application/json: 5511 schema: 5512 type: object 5513 "400": 5514 $ref: "#/components/responses/Err400" 5515 description: VALIDATION_ERROR — request validation failed. 5516 "401": 5517 $ref: "#/components/responses/Err401" 5518 description: UNAUTHORIZED — missing/invalid credentials. 5519 "403": 5520 $ref: "#/components/responses/Err403" 5521 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5522 "404": 5523 $ref: "#/components/responses/Err404" 5524 description: NOT_FOUND — resource does not exist for this caller. 5525 "429": 5526 $ref: "#/components/responses/Err429" 5527 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5528 "500": 5529 $ref: "#/components/responses/Err500" 5530 description: INTERNAL_ERROR — unexpected server error. 5531 /orgs/{orgId}/sso/enforce: 5532 patch: 5533 operationId: PatchOrgsByOrgIdSsoEnforce 5534 tags: 5535 - Orgs 5536 summary: Update orgs by orgId 5537 security: 5538 - bearerAuth: [] 5539 parameters: 5540 - name: orgId 5541 in: path 5542 required: true 5543 schema: 5544 type: string 5545 - $ref: "#/components/parameters/IdempotencyKey" 5546 responses: 5547 "200": 5548 description: OK. 5549 content: 5550 application/json: 5551 schema: 5552 type: object 5553 "400": 5554 $ref: "#/components/responses/Err400" 5555 description: VALIDATION_ERROR — request validation failed. 5556 "401": 5557 $ref: "#/components/responses/Err401" 5558 description: UNAUTHORIZED — missing/invalid credentials. 5559 "403": 5560 $ref: "#/components/responses/Err403" 5561 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5562 "404": 5563 $ref: "#/components/responses/Err404" 5564 description: NOT_FOUND — resource does not exist for this caller. 5565 "409": 5566 $ref: "#/components/responses/Err409" 5567 description: CONFLICT — duplicate or state conflict. 5568 "429": 5569 $ref: "#/components/responses/Err429" 5570 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5571 "500": 5572 $ref: "#/components/responses/Err500" 5573 description: INTERNAL_ERROR — unexpected server error. 5574 /orgs/{orgId}/sso/test: 5575 post: 5576 operationId: PostOrgsByOrgIdSsoTest 5577 tags: 5578 - Orgs 5579 summary: Create orgs by orgId 5580 security: 5581 - bearerAuth: [] 5582 parameters: 5583 - name: orgId 5584 in: path 5585 required: true 5586 schema: 5587 type: string 5588 - $ref: "#/components/parameters/IdempotencyKey" 5589 responses: 5590 "200": 5591 description: OK. 5592 content: 5593 application/json: 5594 schema: 5595 type: object 5596 "400": 5597 $ref: "#/components/responses/Err400" 5598 description: VALIDATION_ERROR — request validation failed. 5599 "401": 5600 $ref: "#/components/responses/Err401" 5601 description: UNAUTHORIZED — missing/invalid credentials. 5602 "403": 5603 $ref: "#/components/responses/Err403" 5604 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5605 "404": 5606 $ref: "#/components/responses/Err404" 5607 description: NOT_FOUND — resource does not exist for this caller. 5608 "429": 5609 $ref: "#/components/responses/Err429" 5610 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5611 "500": 5612 $ref: "#/components/responses/Err500" 5613 description: INTERNAL_ERROR — unexpected server error. 5614 /pages/{id}: 5615 get: 5616 operationId: GetPagesById 5617 tags: 5618 - Pages 5619 summary: Get pages by id 5620 security: 5621 - bearerAuth: [] 5622 parameters: 5623 - name: id 5624 in: path 5625 required: true 5626 schema: 5627 type: string 5628 responses: 5629 "200": 5630 description: OK. 5631 content: 5632 application/json: 5633 schema: 5634 type: object 5635 "401": 5636 $ref: "#/components/responses/Err401" 5637 description: UNAUTHORIZED — missing/invalid credentials. 5638 "403": 5639 $ref: "#/components/responses/Err403" 5640 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5641 "404": 5642 $ref: "#/components/responses/Err404" 5643 description: NOT_FOUND — resource does not exist for this caller. 5644 "429": 5645 $ref: "#/components/responses/Err429" 5646 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5647 "500": 5648 $ref: "#/components/responses/Err500" 5649 description: INTERNAL_ERROR — unexpected server error. 5650 patch: 5651 operationId: PatchPagesById 5652 tags: 5653 - Pages 5654 summary: Update pages by id 5655 security: 5656 - bearerAuth: [] 5657 parameters: 5658 - name: id 5659 in: path 5660 required: true 5661 schema: 5662 type: string 5663 - $ref: "#/components/parameters/IdempotencyKey" 5664 responses: 5665 "200": 5666 description: OK. 5667 content: 5668 application/json: 5669 schema: 5670 type: object 5671 "400": 5672 $ref: "#/components/responses/Err400" 5673 description: VALIDATION_ERROR — request validation failed. 5674 "401": 5675 $ref: "#/components/responses/Err401" 5676 description: UNAUTHORIZED — missing/invalid credentials. 5677 "403": 5678 $ref: "#/components/responses/Err403" 5679 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5680 "404": 5681 $ref: "#/components/responses/Err404" 5682 description: NOT_FOUND — resource does not exist for this caller. 5683 "409": 5684 $ref: "#/components/responses/Err409" 5685 description: CONFLICT — duplicate or state conflict. 5686 "429": 5687 $ref: "#/components/responses/Err429" 5688 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5689 "500": 5690 $ref: "#/components/responses/Err500" 5691 description: INTERNAL_ERROR — unexpected server error. 5692 delete: 5693 operationId: DeletePagesById 5694 tags: 5695 - Pages 5696 summary: Delete pages by id 5697 security: 5698 - bearerAuth: [] 5699 parameters: 5700 - name: id 5701 in: path 5702 required: true 5703 schema: 5704 type: string 5705 - $ref: "#/components/parameters/IdempotencyKey" 5706 responses: 5707 "200": 5708 description: OK. 5709 content: 5710 application/json: 5711 schema: 5712 type: object 5713 "400": 5714 $ref: "#/components/responses/Err400" 5715 description: VALIDATION_ERROR — request validation failed. 5716 "401": 5717 $ref: "#/components/responses/Err401" 5718 description: UNAUTHORIZED — missing/invalid credentials. 5719 "403": 5720 $ref: "#/components/responses/Err403" 5721 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5722 "404": 5723 $ref: "#/components/responses/Err404" 5724 description: NOT_FOUND — resource does not exist for this caller. 5725 "429": 5726 $ref: "#/components/responses/Err429" 5727 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5728 "500": 5729 $ref: "#/components/responses/Err500" 5730 description: INTERNAL_ERROR — unexpected server error. 5731 /pages/{id}/backlinks: 5732 get: 5733 operationId: GetPagesByIdBacklinks 5734 tags: 5735 - Pages 5736 summary: Get pages by id 5737 security: 5738 - bearerAuth: [] 5739 parameters: 5740 - name: id 5741 in: path 5742 required: true 5743 schema: 5744 type: string 5745 responses: 5746 "200": 5747 description: OK. 5748 content: 5749 application/json: 5750 schema: 5751 type: object 5752 "401": 5753 $ref: "#/components/responses/Err401" 5754 description: UNAUTHORIZED — missing/invalid credentials. 5755 "403": 5756 $ref: "#/components/responses/Err403" 5757 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5758 "404": 5759 $ref: "#/components/responses/Err404" 5760 description: NOT_FOUND — resource does not exist for this caller. 5761 "429": 5762 $ref: "#/components/responses/Err429" 5763 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5764 "500": 5765 $ref: "#/components/responses/Err500" 5766 description: INTERNAL_ERROR — unexpected server error. 5767 /pages/{id}/duplicate: 5768 post: 5769 operationId: PostPagesByIdDuplicate 5770 tags: 5771 - Pages 5772 summary: Create pages by id 5773 security: 5774 - bearerAuth: [] 5775 parameters: 5776 - name: id 5777 in: path 5778 required: true 5779 schema: 5780 type: string 5781 - $ref: "#/components/parameters/IdempotencyKey" 5782 responses: 5783 "200": 5784 description: OK. 5785 content: 5786 application/json: 5787 schema: 5788 type: object 5789 "400": 5790 $ref: "#/components/responses/Err400" 5791 description: VALIDATION_ERROR — request validation failed. 5792 "401": 5793 $ref: "#/components/responses/Err401" 5794 description: UNAUTHORIZED — missing/invalid credentials. 5795 "403": 5796 $ref: "#/components/responses/Err403" 5797 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5798 "404": 5799 $ref: "#/components/responses/Err404" 5800 description: NOT_FOUND — resource does not exist for this caller. 5801 "429": 5802 $ref: "#/components/responses/Err429" 5803 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5804 "500": 5805 $ref: "#/components/responses/Err500" 5806 description: INTERNAL_ERROR — unexpected server error. 5807 /pages/{id}/export/markdown: 5808 get: 5809 operationId: GetPagesByIdExportMarkdown 5810 tags: 5811 - Pages 5812 summary: Get pages by id 5813 security: 5814 - bearerAuth: [] 5815 parameters: 5816 - name: id 5817 in: path 5818 required: true 5819 schema: 5820 type: string 5821 responses: 5822 "200": 5823 description: OK. 5824 content: 5825 application/json: 5826 schema: 5827 type: object 5828 "401": 5829 $ref: "#/components/responses/Err401" 5830 description: UNAUTHORIZED — missing/invalid credentials. 5831 "403": 5832 $ref: "#/components/responses/Err403" 5833 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5834 "404": 5835 $ref: "#/components/responses/Err404" 5836 description: NOT_FOUND — resource does not exist for this caller. 5837 "429": 5838 $ref: "#/components/responses/Err429" 5839 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5840 "500": 5841 $ref: "#/components/responses/Err500" 5842 description: INTERNAL_ERROR — unexpected server error. 5843 /pages/{id}/favorite: 5844 get: 5845 operationId: GetPagesByIdFavorite 5846 tags: 5847 - Pages 5848 summary: Get pages by id 5849 security: 5850 - bearerAuth: [] 5851 parameters: 5852 - name: id 5853 in: path 5854 required: true 5855 schema: 5856 type: string 5857 responses: 5858 "200": 5859 description: OK. 5860 content: 5861 application/json: 5862 schema: 5863 type: object 5864 "401": 5865 $ref: "#/components/responses/Err401" 5866 description: UNAUTHORIZED — missing/invalid credentials. 5867 "403": 5868 $ref: "#/components/responses/Err403" 5869 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5870 "404": 5871 $ref: "#/components/responses/Err404" 5872 description: NOT_FOUND — resource does not exist for this caller. 5873 "429": 5874 $ref: "#/components/responses/Err429" 5875 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5876 "500": 5877 $ref: "#/components/responses/Err500" 5878 description: INTERNAL_ERROR — unexpected server error. 5879 post: 5880 operationId: PostPagesByIdFavorite 5881 tags: 5882 - Pages 5883 summary: Create pages by id 5884 security: 5885 - bearerAuth: [] 5886 parameters: 5887 - name: id 5888 in: path 5889 required: true 5890 schema: 5891 type: string 5892 - $ref: "#/components/parameters/IdempotencyKey" 5893 responses: 5894 "200": 5895 description: OK. 5896 content: 5897 application/json: 5898 schema: 5899 type: object 5900 "400": 5901 $ref: "#/components/responses/Err400" 5902 description: VALIDATION_ERROR — request validation failed. 5903 "401": 5904 $ref: "#/components/responses/Err401" 5905 description: UNAUTHORIZED — missing/invalid credentials. 5906 "403": 5907 $ref: "#/components/responses/Err403" 5908 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5909 "404": 5910 $ref: "#/components/responses/Err404" 5911 description: NOT_FOUND — resource does not exist for this caller. 5912 "429": 5913 $ref: "#/components/responses/Err429" 5914 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5915 "500": 5916 $ref: "#/components/responses/Err500" 5917 description: INTERNAL_ERROR — unexpected server error. 5918 delete: 5919 operationId: DeletePagesByIdFavorite 5920 tags: 5921 - Pages 5922 summary: Delete pages by id 5923 security: 5924 - bearerAuth: [] 5925 parameters: 5926 - name: id 5927 in: path 5928 required: true 5929 schema: 5930 type: string 5931 - $ref: "#/components/parameters/IdempotencyKey" 5932 responses: 5933 "200": 5934 description: OK. 5935 content: 5936 application/json: 5937 schema: 5938 type: object 5939 "400": 5940 $ref: "#/components/responses/Err400" 5941 description: VALIDATION_ERROR — request validation failed. 5942 "401": 5943 $ref: "#/components/responses/Err401" 5944 description: UNAUTHORIZED — missing/invalid credentials. 5945 "403": 5946 $ref: "#/components/responses/Err403" 5947 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5948 "404": 5949 $ref: "#/components/responses/Err404" 5950 description: NOT_FOUND — resource does not exist for this caller. 5951 "429": 5952 $ref: "#/components/responses/Err429" 5953 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5954 "500": 5955 $ref: "#/components/responses/Err500" 5956 description: INTERNAL_ERROR — unexpected server error. 5957 /pages/{id}/move: 5958 post: 5959 operationId: PostPagesByIdMove 5960 tags: 5961 - Pages 5962 summary: Create pages by id 5963 security: 5964 - bearerAuth: [] 5965 parameters: 5966 - name: id 5967 in: path 5968 required: true 5969 schema: 5970 type: string 5971 - $ref: "#/components/parameters/IdempotencyKey" 5972 responses: 5973 "200": 5974 description: OK. 5975 content: 5976 application/json: 5977 schema: 5978 type: object 5979 "400": 5980 $ref: "#/components/responses/Err400" 5981 description: VALIDATION_ERROR — request validation failed. 5982 "401": 5983 $ref: "#/components/responses/Err401" 5984 description: UNAUTHORIZED — missing/invalid credentials. 5985 "403": 5986 $ref: "#/components/responses/Err403" 5987 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 5988 "404": 5989 $ref: "#/components/responses/Err404" 5990 description: NOT_FOUND — resource does not exist for this caller. 5991 "429": 5992 $ref: "#/components/responses/Err429" 5993 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 5994 "500": 5995 $ref: "#/components/responses/Err500" 5996 description: INTERNAL_ERROR — unexpected server error. 5997 /pages/{id}/permanent: 5998 delete: 5999 operationId: DeletePagesByIdPermanent 6000 tags: 6001 - Pages 6002 summary: Permanently delete a page 6003 security: 6004 - bearerAuth: [] 6005 parameters: 6006 - name: id 6007 in: path 6008 required: true 6009 schema: 6010 type: string 6011 - $ref: "#/components/parameters/IdempotencyKey" 6012 responses: 6013 "200": 6014 description: OK. 6015 content: 6016 application/json: 6017 schema: 6018 type: object 6019 "400": 6020 $ref: "#/components/responses/Err400" 6021 description: VALIDATION_ERROR — request validation failed. 6022 "401": 6023 $ref: "#/components/responses/Err401" 6024 description: UNAUTHORIZED — missing/invalid credentials. 6025 "403": 6026 $ref: "#/components/responses/Err403" 6027 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6028 "404": 6029 $ref: "#/components/responses/Err404" 6030 description: NOT_FOUND — resource does not exist for this caller. 6031 "429": 6032 $ref: "#/components/responses/Err429" 6033 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6034 "500": 6035 $ref: "#/components/responses/Err500" 6036 description: INTERNAL_ERROR — unexpected server error. 6037 /pages/{id}/restore: 6038 post: 6039 operationId: PostPagesByIdRestore 6040 tags: 6041 - Pages 6042 summary: Restore a page from the trash 6043 security: 6044 - bearerAuth: [] 6045 parameters: 6046 - name: id 6047 in: path 6048 required: true 6049 schema: 6050 type: string 6051 - $ref: "#/components/parameters/IdempotencyKey" 6052 responses: 6053 "200": 6054 description: OK. 6055 content: 6056 application/json: 6057 schema: 6058 type: object 6059 "400": 6060 $ref: "#/components/responses/Err400" 6061 description: VALIDATION_ERROR — request validation failed. 6062 "401": 6063 $ref: "#/components/responses/Err401" 6064 description: UNAUTHORIZED — missing/invalid credentials. 6065 "403": 6066 $ref: "#/components/responses/Err403" 6067 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6068 "404": 6069 $ref: "#/components/responses/Err404" 6070 description: NOT_FOUND — resource does not exist for this caller. 6071 "429": 6072 $ref: "#/components/responses/Err429" 6073 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6074 "500": 6075 $ref: "#/components/responses/Err500" 6076 description: INTERNAL_ERROR — unexpected server error. 6077 /pages/{id}/review: 6078 get: 6079 operationId: GetPagesByIdReview 6080 tags: 6081 - Pages 6082 summary: Get pages by id 6083 security: 6084 - bearerAuth: [] 6085 parameters: 6086 - name: id 6087 in: path 6088 required: true 6089 schema: 6090 type: string 6091 responses: 6092 "200": 6093 description: OK. 6094 content: 6095 application/json: 6096 schema: 6097 type: object 6098 "401": 6099 $ref: "#/components/responses/Err401" 6100 description: UNAUTHORIZED — missing/invalid credentials. 6101 "403": 6102 $ref: "#/components/responses/Err403" 6103 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6104 "404": 6105 $ref: "#/components/responses/Err404" 6106 description: NOT_FOUND — resource does not exist for this caller. 6107 "429": 6108 $ref: "#/components/responses/Err429" 6109 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6110 "500": 6111 $ref: "#/components/responses/Err500" 6112 description: INTERNAL_ERROR — unexpected server error. 6113 post: 6114 operationId: PostPagesByIdReview 6115 tags: 6116 - Pages 6117 summary: Create pages by id 6118 security: 6119 - bearerAuth: [] 6120 parameters: 6121 - name: id 6122 in: path 6123 required: true 6124 schema: 6125 type: string 6126 - $ref: "#/components/parameters/IdempotencyKey" 6127 responses: 6128 "200": 6129 description: OK. 6130 content: 6131 application/json: 6132 schema: 6133 type: object 6134 "400": 6135 $ref: "#/components/responses/Err400" 6136 description: VALIDATION_ERROR — request validation failed. 6137 "401": 6138 $ref: "#/components/responses/Err401" 6139 description: UNAUTHORIZED — missing/invalid credentials. 6140 "403": 6141 $ref: "#/components/responses/Err403" 6142 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6143 "404": 6144 $ref: "#/components/responses/Err404" 6145 description: NOT_FOUND — resource does not exist for this caller. 6146 "429": 6147 $ref: "#/components/responses/Err429" 6148 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6149 "500": 6150 $ref: "#/components/responses/Err500" 6151 description: INTERNAL_ERROR — unexpected server error. 6152 /pages/{id}/templates: 6153 post: 6154 operationId: PostPagesByIdTemplates 6155 tags: 6156 - Pages 6157 summary: Save a page as a template 6158 security: 6159 - bearerAuth: [] 6160 parameters: 6161 - name: id 6162 in: path 6163 required: true 6164 schema: 6165 type: string 6166 - $ref: "#/components/parameters/IdempotencyKey" 6167 responses: 6168 "200": 6169 description: OK. 6170 content: 6171 application/json: 6172 schema: 6173 type: object 6174 "400": 6175 $ref: "#/components/responses/Err400" 6176 description: VALIDATION_ERROR — request validation failed. 6177 "401": 6178 $ref: "#/components/responses/Err401" 6179 description: UNAUTHORIZED — missing/invalid credentials. 6180 "403": 6181 $ref: "#/components/responses/Err403" 6182 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6183 "404": 6184 $ref: "#/components/responses/Err404" 6185 description: NOT_FOUND — resource does not exist for this caller. 6186 "429": 6187 $ref: "#/components/responses/Err429" 6188 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6189 "500": 6190 $ref: "#/components/responses/Err500" 6191 description: INTERNAL_ERROR — unexpected server error. 6192 /pages/{id}/versions: 6193 get: 6194 operationId: GetPagesByIdVersions 6195 tags: 6196 - Pages 6197 summary: Get pages by id 6198 security: 6199 - bearerAuth: [] 6200 parameters: 6201 - name: id 6202 in: path 6203 required: true 6204 schema: 6205 type: string 6206 responses: 6207 "200": 6208 description: OK. 6209 content: 6210 application/json: 6211 schema: 6212 type: object 6213 "401": 6214 $ref: "#/components/responses/Err401" 6215 description: UNAUTHORIZED — missing/invalid credentials. 6216 "403": 6217 $ref: "#/components/responses/Err403" 6218 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6219 "404": 6220 $ref: "#/components/responses/Err404" 6221 description: NOT_FOUND — resource does not exist for this caller. 6222 "429": 6223 $ref: "#/components/responses/Err429" 6224 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6225 "500": 6226 $ref: "#/components/responses/Err500" 6227 description: INTERNAL_ERROR — unexpected server error. 6228 post: 6229 operationId: PostPagesByIdVersions 6230 tags: 6231 - Pages 6232 summary: Create pages by id 6233 security: 6234 - bearerAuth: [] 6235 parameters: 6236 - name: id 6237 in: path 6238 required: true 6239 schema: 6240 type: string 6241 - $ref: "#/components/parameters/IdempotencyKey" 6242 responses: 6243 "201": 6244 description: The created resource. 6245 content: 6246 application/json: 6247 schema: 6248 type: object 6249 "400": 6250 $ref: "#/components/responses/Err400" 6251 description: VALIDATION_ERROR — request validation failed. 6252 "401": 6253 $ref: "#/components/responses/Err401" 6254 description: UNAUTHORIZED — missing/invalid credentials. 6255 "403": 6256 $ref: "#/components/responses/Err403" 6257 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6258 "404": 6259 $ref: "#/components/responses/Err404" 6260 description: NOT_FOUND — resource does not exist for this caller. 6261 "409": 6262 $ref: "#/components/responses/Err409" 6263 description: CONFLICT — duplicate or state conflict. 6264 "429": 6265 $ref: "#/components/responses/Err429" 6266 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6267 "500": 6268 $ref: "#/components/responses/Err500" 6269 description: INTERNAL_ERROR — unexpected server error. 6270 /pages/{id}/versions/{versionId}: 6271 get: 6272 operationId: GetPagesByIdVersionsByVersionId 6273 tags: 6274 - Pages 6275 summary: Get pages by id + versionId 6276 security: 6277 - bearerAuth: [] 6278 parameters: 6279 - name: id 6280 in: path 6281 required: true 6282 schema: 6283 type: string 6284 - name: versionId 6285 in: path 6286 required: true 6287 schema: 6288 type: string 6289 responses: 6290 "200": 6291 description: OK. 6292 content: 6293 application/json: 6294 schema: 6295 type: object 6296 "401": 6297 $ref: "#/components/responses/Err401" 6298 description: UNAUTHORIZED — missing/invalid credentials. 6299 "403": 6300 $ref: "#/components/responses/Err403" 6301 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6302 "404": 6303 $ref: "#/components/responses/Err404" 6304 description: NOT_FOUND — resource does not exist for this caller. 6305 "429": 6306 $ref: "#/components/responses/Err429" 6307 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6308 "500": 6309 $ref: "#/components/responses/Err500" 6310 description: INTERNAL_ERROR — unexpected server error. 6311 /pages/{id}/versions/{versionId}/restore: 6312 post: 6313 operationId: PostPagesByIdVersionsByVersionIdRestore 6314 tags: 6315 - Pages 6316 summary: Create pages by id + versionId 6317 security: 6318 - bearerAuth: [] 6319 parameters: 6320 - name: id 6321 in: path 6322 required: true 6323 schema: 6324 type: string 6325 - name: versionId 6326 in: path 6327 required: true 6328 schema: 6329 type: string 6330 - $ref: "#/components/parameters/IdempotencyKey" 6331 responses: 6332 "200": 6333 description: OK. 6334 content: 6335 application/json: 6336 schema: 6337 type: object 6338 "400": 6339 $ref: "#/components/responses/Err400" 6340 description: VALIDATION_ERROR — request validation failed. 6341 "401": 6342 $ref: "#/components/responses/Err401" 6343 description: UNAUTHORIZED — missing/invalid credentials. 6344 "403": 6345 $ref: "#/components/responses/Err403" 6346 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6347 "404": 6348 $ref: "#/components/responses/Err404" 6349 description: NOT_FOUND — resource does not exist for this caller. 6350 "429": 6351 $ref: "#/components/responses/Err429" 6352 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6353 "500": 6354 $ref: "#/components/responses/Err500" 6355 description: INTERNAL_ERROR — unexpected server error. 6356 /pages/{id}/versions/compare: 6357 get: 6358 operationId: GetPagesByIdVersionsCompare 6359 tags: 6360 - Pages 6361 summary: Get pages by id 6362 security: 6363 - bearerAuth: [] 6364 parameters: 6365 - name: id 6366 in: path 6367 required: true 6368 schema: 6369 type: string 6370 responses: 6371 "200": 6372 description: OK. 6373 content: 6374 application/json: 6375 schema: 6376 type: object 6377 "401": 6378 $ref: "#/components/responses/Err401" 6379 description: UNAUTHORIZED — missing/invalid credentials. 6380 "403": 6381 $ref: "#/components/responses/Err403" 6382 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6383 "404": 6384 $ref: "#/components/responses/Err404" 6385 description: NOT_FOUND — resource does not exist for this caller. 6386 "429": 6387 $ref: "#/components/responses/Err429" 6388 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6389 "500": 6390 $ref: "#/components/responses/Err500" 6391 description: INTERNAL_ERROR — unexpected server error. 6392 /pages/{id}/watch: 6393 get: 6394 operationId: GetPagesByIdWatch 6395 tags: 6396 - Pages 6397 summary: Get pages by id 6398 security: 6399 - bearerAuth: [] 6400 parameters: 6401 - name: id 6402 in: path 6403 required: true 6404 schema: 6405 type: string 6406 responses: 6407 "200": 6408 description: OK. 6409 content: 6410 application/json: 6411 schema: 6412 type: object 6413 "401": 6414 $ref: "#/components/responses/Err401" 6415 description: UNAUTHORIZED — missing/invalid credentials. 6416 "403": 6417 $ref: "#/components/responses/Err403" 6418 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6419 "404": 6420 $ref: "#/components/responses/Err404" 6421 description: NOT_FOUND — resource does not exist for this caller. 6422 "429": 6423 $ref: "#/components/responses/Err429" 6424 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6425 "500": 6426 $ref: "#/components/responses/Err500" 6427 description: INTERNAL_ERROR — unexpected server error. 6428 post: 6429 operationId: PostPagesByIdWatch 6430 tags: 6431 - Pages 6432 summary: Create pages by id 6433 security: 6434 - bearerAuth: [] 6435 parameters: 6436 - name: id 6437 in: path 6438 required: true 6439 schema: 6440 type: string 6441 - $ref: "#/components/parameters/IdempotencyKey" 6442 responses: 6443 "200": 6444 description: OK. 6445 content: 6446 application/json: 6447 schema: 6448 type: object 6449 "400": 6450 $ref: "#/components/responses/Err400" 6451 description: VALIDATION_ERROR — request validation failed. 6452 "401": 6453 $ref: "#/components/responses/Err401" 6454 description: UNAUTHORIZED — missing/invalid credentials. 6455 "403": 6456 $ref: "#/components/responses/Err403" 6457 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6458 "404": 6459 $ref: "#/components/responses/Err404" 6460 description: NOT_FOUND — resource does not exist for this caller. 6461 "429": 6462 $ref: "#/components/responses/Err429" 6463 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6464 "500": 6465 $ref: "#/components/responses/Err500" 6466 description: INTERNAL_ERROR — unexpected server error. 6467 delete: 6468 operationId: DeletePagesByIdWatch 6469 tags: 6470 - Pages 6471 summary: Delete pages by id 6472 security: 6473 - bearerAuth: [] 6474 parameters: 6475 - name: id 6476 in: path 6477 required: true 6478 schema: 6479 type: string 6480 - $ref: "#/components/parameters/IdempotencyKey" 6481 responses: 6482 "200": 6483 description: OK. 6484 content: 6485 application/json: 6486 schema: 6487 type: object 6488 "400": 6489 $ref: "#/components/responses/Err400" 6490 description: VALIDATION_ERROR — request validation failed. 6491 "401": 6492 $ref: "#/components/responses/Err401" 6493 description: UNAUTHORIZED — missing/invalid credentials. 6494 "403": 6495 $ref: "#/components/responses/Err403" 6496 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6497 "404": 6498 $ref: "#/components/responses/Err404" 6499 description: NOT_FOUND — resource does not exist for this caller. 6500 "429": 6501 $ref: "#/components/responses/Err429" 6502 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6503 "500": 6504 $ref: "#/components/responses/Err500" 6505 description: INTERNAL_ERROR — unexpected server error. 6506 /pages/{id}/whiteboard: 6507 get: 6508 operationId: GetPagesByIdWhiteboard 6509 tags: 6510 - Pages 6511 summary: Get pages by id 6512 security: 6513 - bearerAuth: [] 6514 parameters: 6515 - name: id 6516 in: path 6517 required: true 6518 schema: 6519 type: string 6520 responses: 6521 "200": 6522 description: OK. 6523 content: 6524 application/json: 6525 schema: 6526 type: object 6527 "401": 6528 $ref: "#/components/responses/Err401" 6529 description: UNAUTHORIZED — missing/invalid credentials. 6530 "403": 6531 $ref: "#/components/responses/Err403" 6532 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6533 "404": 6534 $ref: "#/components/responses/Err404" 6535 description: NOT_FOUND — resource does not exist for this caller. 6536 "429": 6537 $ref: "#/components/responses/Err429" 6538 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6539 "500": 6540 $ref: "#/components/responses/Err500" 6541 description: INTERNAL_ERROR — unexpected server error. 6542 put: 6543 operationId: PutPagesByIdWhiteboard 6544 tags: 6545 - Pages 6546 summary: Replace pages by id 6547 security: 6548 - bearerAuth: [] 6549 parameters: 6550 - name: id 6551 in: path 6552 required: true 6553 schema: 6554 type: string 6555 - $ref: "#/components/parameters/IdempotencyKey" 6556 responses: 6557 "200": 6558 description: OK. 6559 content: 6560 application/json: 6561 schema: 6562 type: object 6563 "400": 6564 $ref: "#/components/responses/Err400" 6565 description: VALIDATION_ERROR — request validation failed. 6566 "401": 6567 $ref: "#/components/responses/Err401" 6568 description: UNAUTHORIZED — missing/invalid credentials. 6569 "403": 6570 $ref: "#/components/responses/Err403" 6571 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6572 "404": 6573 $ref: "#/components/responses/Err404" 6574 description: NOT_FOUND — resource does not exist for this caller. 6575 "409": 6576 $ref: "#/components/responses/Err409" 6577 description: CONFLICT — duplicate or state conflict. 6578 "429": 6579 $ref: "#/components/responses/Err429" 6580 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6581 "500": 6582 $ref: "#/components/responses/Err500" 6583 description: INTERNAL_ERROR — unexpected server error. 6584 /pages/{id}/whiteboard/convert: 6585 post: 6586 operationId: PostPagesByIdWhiteboardConvert 6587 tags: 6588 - Pages 6589 summary: Create pages by id 6590 security: 6591 - bearerAuth: [] 6592 parameters: 6593 - name: id 6594 in: path 6595 required: true 6596 schema: 6597 type: string 6598 - $ref: "#/components/parameters/IdempotencyKey" 6599 responses: 6600 "201": 6601 description: The created resource. 6602 content: 6603 application/json: 6604 schema: 6605 type: object 6606 "400": 6607 $ref: "#/components/responses/Err400" 6608 description: VALIDATION_ERROR — request validation failed. 6609 "401": 6610 $ref: "#/components/responses/Err401" 6611 description: UNAUTHORIZED — missing/invalid credentials. 6612 "403": 6613 $ref: "#/components/responses/Err403" 6614 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6615 "404": 6616 $ref: "#/components/responses/Err404" 6617 description: NOT_FOUND — resource does not exist for this caller. 6618 "409": 6619 $ref: "#/components/responses/Err409" 6620 description: CONFLICT — duplicate or state conflict. 6621 "429": 6622 $ref: "#/components/responses/Err429" 6623 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6624 "500": 6625 $ref: "#/components/responses/Err500" 6626 description: INTERNAL_ERROR — unexpected server error. 6627 /pages/{pageId}/blocks: 6628 get: 6629 operationId: GetPagesByPageIdBlocks 6630 tags: 6631 - Pages 6632 summary: Get pages by pageId 6633 security: 6634 - bearerAuth: [] 6635 parameters: 6636 - name: pageId 6637 in: path 6638 required: true 6639 schema: 6640 type: string 6641 responses: 6642 "200": 6643 description: OK. 6644 content: 6645 application/json: 6646 schema: 6647 type: object 6648 "401": 6649 $ref: "#/components/responses/Err401" 6650 description: UNAUTHORIZED — missing/invalid credentials. 6651 "403": 6652 $ref: "#/components/responses/Err403" 6653 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6654 "404": 6655 $ref: "#/components/responses/Err404" 6656 description: NOT_FOUND — resource does not exist for this caller. 6657 "429": 6658 $ref: "#/components/responses/Err429" 6659 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6660 "500": 6661 $ref: "#/components/responses/Err500" 6662 description: INTERNAL_ERROR — unexpected server error. 6663 post: 6664 operationId: PostPagesByPageIdBlocks 6665 tags: 6666 - Pages 6667 summary: Create pages by pageId 6668 security: 6669 - bearerAuth: [] 6670 parameters: 6671 - name: pageId 6672 in: path 6673 required: true 6674 schema: 6675 type: string 6676 - $ref: "#/components/parameters/IdempotencyKey" 6677 responses: 6678 "201": 6679 description: The created resource. 6680 content: 6681 application/json: 6682 schema: 6683 type: object 6684 "400": 6685 $ref: "#/components/responses/Err400" 6686 description: VALIDATION_ERROR — request validation failed. 6687 "401": 6688 $ref: "#/components/responses/Err401" 6689 description: UNAUTHORIZED — missing/invalid credentials. 6690 "403": 6691 $ref: "#/components/responses/Err403" 6692 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6693 "404": 6694 $ref: "#/components/responses/Err404" 6695 description: NOT_FOUND — resource does not exist for this caller. 6696 "409": 6697 $ref: "#/components/responses/Err409" 6698 description: CONFLICT — duplicate or state conflict. 6699 "429": 6700 $ref: "#/components/responses/Err429" 6701 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6702 "500": 6703 $ref: "#/components/responses/Err500" 6704 description: INTERNAL_ERROR — unexpected server error. 6705 /pages/{pageId}/content: 6706 get: 6707 operationId: GetPagesByPageIdContent 6708 tags: 6709 - Pages 6710 summary: Get pages by pageId 6711 security: 6712 - bearerAuth: [] 6713 parameters: 6714 - name: pageId 6715 in: path 6716 required: true 6717 schema: 6718 type: string 6719 responses: 6720 "200": 6721 description: OK. 6722 content: 6723 application/json: 6724 schema: 6725 type: object 6726 "401": 6727 $ref: "#/components/responses/Err401" 6728 description: UNAUTHORIZED — missing/invalid credentials. 6729 "403": 6730 $ref: "#/components/responses/Err403" 6731 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6732 "404": 6733 $ref: "#/components/responses/Err404" 6734 description: NOT_FOUND — resource does not exist for this caller. 6735 "429": 6736 $ref: "#/components/responses/Err429" 6737 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6738 "500": 6739 $ref: "#/components/responses/Err500" 6740 description: INTERNAL_ERROR — unexpected server error. 6741 /pages/bulk: 6742 post: 6743 operationId: PostPagesBulk 6744 tags: 6745 - Pages 6746 summary: Create pages 6747 security: 6748 - bearerAuth: [] 6749 parameters: 6750 - $ref: "#/components/parameters/IdempotencyKey" 6751 responses: 6752 "200": 6753 description: OK. 6754 content: 6755 application/json: 6756 schema: 6757 type: object 6758 "400": 6759 $ref: "#/components/responses/Err400" 6760 description: VALIDATION_ERROR — request validation failed. 6761 "401": 6762 $ref: "#/components/responses/Err401" 6763 description: UNAUTHORIZED — missing/invalid credentials. 6764 "403": 6765 $ref: "#/components/responses/Err403" 6766 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6767 "404": 6768 $ref: "#/components/responses/Err404" 6769 description: NOT_FOUND — resource does not exist for this caller. 6770 "429": 6771 $ref: "#/components/responses/Err429" 6772 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6773 "500": 6774 $ref: "#/components/responses/Err500" 6775 description: INTERNAL_ERROR — unexpected server error. 6776 /public/forms/{slug}: 6777 get: 6778 operationId: GetPublicFormsBySlug 6779 tags: 6780 - Public Forms 6781 summary: Open a public form (unauthenticated) 6782 security: [] 6783 parameters: 6784 - name: slug 6785 in: path 6786 required: true 6787 schema: 6788 type: string 6789 responses: 6790 "200": 6791 description: OK. 6792 content: 6793 application/json: 6794 schema: 6795 type: object 6796 "429": 6797 $ref: "#/components/responses/Err429" 6798 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6799 "500": 6800 $ref: "#/components/responses/Err500" 6801 description: INTERNAL_ERROR — unexpected server error. 6802 /public/forms/{slug}/files: 6803 post: 6804 operationId: PostPublicFormsBySlugFiles 6805 tags: 6806 - Public Forms 6807 summary: Create public forms by slug 6808 security: [] 6809 parameters: 6810 - name: slug 6811 in: path 6812 required: true 6813 schema: 6814 type: string 6815 - $ref: "#/components/parameters/IdempotencyKey" 6816 responses: 6817 "200": 6818 description: OK. 6819 content: 6820 application/json: 6821 schema: 6822 type: object 6823 "400": 6824 $ref: "#/components/responses/Err400" 6825 description: VALIDATION_ERROR — request validation failed. 6826 "429": 6827 $ref: "#/components/responses/Err429" 6828 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6829 "500": 6830 $ref: "#/components/responses/Err500" 6831 description: INTERNAL_ERROR — unexpected server error. 6832 /public/forms/{slug}/files/{fileId}/complete: 6833 put: 6834 operationId: PutPublicFormsBySlugFilesByFileIdComplete 6835 tags: 6836 - Public Forms 6837 summary: Replace public forms by slug + fileId 6838 security: [] 6839 parameters: 6840 - name: slug 6841 in: path 6842 required: true 6843 schema: 6844 type: string 6845 - name: fileId 6846 in: path 6847 required: true 6848 schema: 6849 type: string 6850 - $ref: "#/components/parameters/IdempotencyKey" 6851 responses: 6852 "200": 6853 description: OK. 6854 content: 6855 application/json: 6856 schema: 6857 type: object 6858 "400": 6859 $ref: "#/components/responses/Err400" 6860 description: VALIDATION_ERROR — request validation failed. 6861 "409": 6862 $ref: "#/components/responses/Err409" 6863 description: CONFLICT — duplicate or state conflict. 6864 "429": 6865 $ref: "#/components/responses/Err429" 6866 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6867 "500": 6868 $ref: "#/components/responses/Err500" 6869 description: INTERNAL_ERROR — unexpected server error. 6870 /public/forms/{slug}/submit: 6871 post: 6872 operationId: PostPublicFormsBySlugSubmit 6873 tags: 6874 - Public Forms 6875 summary: Submit a public form (unauthenticated) 6876 security: [] 6877 parameters: 6878 - name: slug 6879 in: path 6880 required: true 6881 schema: 6882 type: string 6883 - $ref: "#/components/parameters/IdempotencyKey" 6884 responses: 6885 "200": 6886 description: OK. 6887 content: 6888 application/json: 6889 schema: 6890 type: object 6891 "400": 6892 $ref: "#/components/responses/Err400" 6893 description: VALIDATION_ERROR — request validation failed. 6894 "429": 6895 $ref: "#/components/responses/Err429" 6896 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6897 "500": 6898 $ref: "#/components/responses/Err500" 6899 description: INTERNAL_ERROR — unexpected server error. 6900 /records/{id}: 6901 get: 6902 operationId: GetRecordsById 6903 tags: 6904 - Records 6905 summary: Get records by id 6906 security: 6907 - bearerAuth: [] 6908 parameters: 6909 - name: id 6910 in: path 6911 required: true 6912 schema: 6913 type: string 6914 responses: 6915 "200": 6916 description: OK. 6917 content: 6918 application/json: 6919 schema: 6920 type: object 6921 "401": 6922 $ref: "#/components/responses/Err401" 6923 description: UNAUTHORIZED — missing/invalid credentials. 6924 "403": 6925 $ref: "#/components/responses/Err403" 6926 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6927 "404": 6928 $ref: "#/components/responses/Err404" 6929 description: NOT_FOUND — resource does not exist for this caller. 6930 "429": 6931 $ref: "#/components/responses/Err429" 6932 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6933 "500": 6934 $ref: "#/components/responses/Err500" 6935 description: INTERNAL_ERROR — unexpected server error. 6936 patch: 6937 operationId: PatchRecordsById 6938 tags: 6939 - Records 6940 summary: Update records by id 6941 security: 6942 - bearerAuth: [] 6943 parameters: 6944 - name: id 6945 in: path 6946 required: true 6947 schema: 6948 type: string 6949 - $ref: "#/components/parameters/IdempotencyKey" 6950 responses: 6951 "200": 6952 description: OK. 6953 content: 6954 application/json: 6955 schema: 6956 type: object 6957 "400": 6958 $ref: "#/components/responses/Err400" 6959 description: VALIDATION_ERROR — request validation failed. 6960 "401": 6961 $ref: "#/components/responses/Err401" 6962 description: UNAUTHORIZED — missing/invalid credentials. 6963 "403": 6964 $ref: "#/components/responses/Err403" 6965 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 6966 "404": 6967 $ref: "#/components/responses/Err404" 6968 description: NOT_FOUND — resource does not exist for this caller. 6969 "409": 6970 $ref: "#/components/responses/Err409" 6971 description: CONFLICT — duplicate or state conflict. 6972 "429": 6973 $ref: "#/components/responses/Err429" 6974 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 6975 "500": 6976 $ref: "#/components/responses/Err500" 6977 description: INTERNAL_ERROR — unexpected server error. 6978 delete: 6979 operationId: DeleteRecordsById 6980 tags: 6981 - Records 6982 summary: Delete records by id 6983 security: 6984 - bearerAuth: [] 6985 parameters: 6986 - name: id 6987 in: path 6988 required: true 6989 schema: 6990 type: string 6991 - $ref: "#/components/parameters/IdempotencyKey" 6992 responses: 6993 "200": 6994 description: OK. 6995 content: 6996 application/json: 6997 schema: 6998 type: object 6999 "400": 7000 $ref: "#/components/responses/Err400" 7001 description: VALIDATION_ERROR — request validation failed. 7002 "401": 7003 $ref: "#/components/responses/Err401" 7004 description: UNAUTHORIZED — missing/invalid credentials. 7005 "403": 7006 $ref: "#/components/responses/Err403" 7007 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7008 "404": 7009 $ref: "#/components/responses/Err404" 7010 description: NOT_FOUND — resource does not exist for this caller. 7011 "429": 7012 $ref: "#/components/responses/Err429" 7013 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7014 "500": 7015 $ref: "#/components/responses/Err500" 7016 description: INTERNAL_ERROR — unexpected server error. 7017 /records/{id}/formula/{formulaId}: 7018 get: 7019 operationId: GetRecordsByIdFormulaByFormulaId 7020 tags: 7021 - Records 7022 summary: Get records by id + formulaId 7023 security: 7024 - bearerAuth: [] 7025 parameters: 7026 - name: id 7027 in: path 7028 required: true 7029 schema: 7030 type: string 7031 - name: formulaId 7032 in: path 7033 required: true 7034 schema: 7035 type: string 7036 responses: 7037 "200": 7038 description: OK. 7039 content: 7040 application/json: 7041 schema: 7042 type: object 7043 "401": 7044 $ref: "#/components/responses/Err401" 7045 description: UNAUTHORIZED — missing/invalid credentials. 7046 "403": 7047 $ref: "#/components/responses/Err403" 7048 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7049 "404": 7050 $ref: "#/components/responses/Err404" 7051 description: NOT_FOUND — resource does not exist for this caller. 7052 "429": 7053 $ref: "#/components/responses/Err429" 7054 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7055 "500": 7056 $ref: "#/components/responses/Err500" 7057 description: INTERNAL_ERROR — unexpected server error. 7058 /records/{id}/relations: 7059 get: 7060 operationId: GetRecordsByIdRelations 7061 tags: 7062 - Records 7063 summary: Get records by id 7064 security: 7065 - bearerAuth: [] 7066 parameters: 7067 - name: id 7068 in: path 7069 required: true 7070 schema: 7071 type: string 7072 responses: 7073 "200": 7074 description: OK. 7075 content: 7076 application/json: 7077 schema: 7078 type: object 7079 "401": 7080 $ref: "#/components/responses/Err401" 7081 description: UNAUTHORIZED — missing/invalid credentials. 7082 "403": 7083 $ref: "#/components/responses/Err403" 7084 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7085 "404": 7086 $ref: "#/components/responses/Err404" 7087 description: NOT_FOUND — resource does not exist for this caller. 7088 "429": 7089 $ref: "#/components/responses/Err429" 7090 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7091 "500": 7092 $ref: "#/components/responses/Err500" 7093 description: INTERNAL_ERROR — unexpected server error. 7094 /search: 7095 post: 7096 operationId: PostSearch 7097 tags: 7098 - Search 7099 summary: Run a workspace search 7100 security: 7101 - bearerAuth: [] 7102 parameters: 7103 - $ref: "#/components/parameters/IdempotencyKey" 7104 responses: 7105 "200": 7106 description: OK. 7107 content: 7108 application/json: 7109 schema: 7110 type: object 7111 "400": 7112 $ref: "#/components/responses/Err400" 7113 description: VALIDATION_ERROR — request validation failed. 7114 "401": 7115 $ref: "#/components/responses/Err401" 7116 description: UNAUTHORIZED — missing/invalid credentials. 7117 "403": 7118 $ref: "#/components/responses/Err403" 7119 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7120 "404": 7121 $ref: "#/components/responses/Err404" 7122 description: NOT_FOUND — resource does not exist for this caller. 7123 "429": 7124 $ref: "#/components/responses/Err429" 7125 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7126 "500": 7127 $ref: "#/components/responses/Err500" 7128 description: INTERNAL_ERROR — unexpected server error. 7129 /search/query: 7130 get: 7131 operationId: GetSearchQuery 7132 tags: 7133 - Search 7134 summary: List search 7135 security: 7136 - bearerAuth: [] 7137 parameters: [] 7138 responses: 7139 "200": 7140 description: OK. 7141 content: 7142 application/json: 7143 schema: 7144 type: object 7145 "401": 7146 $ref: "#/components/responses/Err401" 7147 description: UNAUTHORIZED — missing/invalid credentials. 7148 "403": 7149 $ref: "#/components/responses/Err403" 7150 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7151 "404": 7152 $ref: "#/components/responses/Err404" 7153 description: NOT_FOUND — resource does not exist for this caller. 7154 "429": 7155 $ref: "#/components/responses/Err429" 7156 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7157 "500": 7158 $ref: "#/components/responses/Err500" 7159 description: INTERNAL_ERROR — unexpected server error. 7160 /search/recent: 7161 get: 7162 operationId: GetSearchRecent 7163 tags: 7164 - Search 7165 summary: List search 7166 security: 7167 - bearerAuth: [] 7168 parameters: [] 7169 responses: 7170 "200": 7171 description: OK. 7172 content: 7173 application/json: 7174 schema: 7175 type: object 7176 "401": 7177 $ref: "#/components/responses/Err401" 7178 description: UNAUTHORIZED — missing/invalid credentials. 7179 "429": 7180 $ref: "#/components/responses/Err429" 7181 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7182 "500": 7183 $ref: "#/components/responses/Err500" 7184 description: INTERNAL_ERROR — unexpected server error. 7185 put: 7186 operationId: PutSearchRecent 7187 tags: 7188 - Search 7189 summary: Replace search 7190 security: 7191 - bearerAuth: [] 7192 parameters: 7193 - $ref: "#/components/parameters/IdempotencyKey" 7194 responses: 7195 "200": 7196 description: OK. 7197 content: 7198 application/json: 7199 schema: 7200 type: object 7201 "400": 7202 $ref: "#/components/responses/Err400" 7203 description: VALIDATION_ERROR — request validation failed. 7204 "401": 7205 $ref: "#/components/responses/Err401" 7206 description: UNAUTHORIZED — missing/invalid credentials. 7207 "409": 7208 $ref: "#/components/responses/Err409" 7209 description: CONFLICT — duplicate or state conflict. 7210 "429": 7211 $ref: "#/components/responses/Err429" 7212 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7213 "500": 7214 $ref: "#/components/responses/Err500" 7215 description: INTERNAL_ERROR — unexpected server error. 7216 delete: 7217 operationId: DeleteSearchRecent 7218 tags: 7219 - Search 7220 summary: Delete search 7221 security: 7222 - bearerAuth: [] 7223 parameters: 7224 - $ref: "#/components/parameters/IdempotencyKey" 7225 responses: 7226 "200": 7227 description: OK. 7228 content: 7229 application/json: 7230 schema: 7231 type: object 7232 "400": 7233 $ref: "#/components/responses/Err400" 7234 description: VALIDATION_ERROR — request validation failed. 7235 "401": 7236 $ref: "#/components/responses/Err401" 7237 description: UNAUTHORIZED — missing/invalid credentials. 7238 "429": 7239 $ref: "#/components/responses/Err429" 7240 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7241 "500": 7242 $ref: "#/components/responses/Err500" 7243 description: INTERNAL_ERROR — unexpected server error. 7244 /search/suggest: 7245 get: 7246 operationId: GetSearchSuggest 7247 tags: 7248 - Search 7249 summary: List search 7250 security: 7251 - bearerAuth: [] 7252 parameters: [] 7253 responses: 7254 "200": 7255 description: OK. 7256 content: 7257 application/json: 7258 schema: 7259 type: object 7260 "401": 7261 $ref: "#/components/responses/Err401" 7262 description: UNAUTHORIZED — missing/invalid credentials. 7263 "403": 7264 $ref: "#/components/responses/Err403" 7265 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7266 "404": 7267 $ref: "#/components/responses/Err404" 7268 description: NOT_FOUND — resource does not exist for this caller. 7269 "429": 7270 $ref: "#/components/responses/Err429" 7271 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7272 "500": 7273 $ref: "#/components/responses/Err500" 7274 description: INTERNAL_ERROR — unexpected server error. 7275 /sessions: 7276 get: 7277 operationId: GetSessions 7278 tags: 7279 - Sessions 7280 summary: List sessions 7281 security: 7282 - bearerAuth: [] 7283 parameters: [] 7284 responses: 7285 "200": 7286 description: OK. 7287 content: 7288 application/json: 7289 schema: 7290 type: object 7291 "401": 7292 $ref: "#/components/responses/Err401" 7293 description: UNAUTHORIZED — missing/invalid credentials. 7294 "429": 7295 $ref: "#/components/responses/Err429" 7296 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7297 "500": 7298 $ref: "#/components/responses/Err500" 7299 description: INTERNAL_ERROR — unexpected server error. 7300 delete: 7301 operationId: DeleteSessions 7302 tags: 7303 - Sessions 7304 summary: End all other sessions 7305 security: 7306 - bearerAuth: [] 7307 parameters: 7308 - $ref: "#/components/parameters/IdempotencyKey" 7309 responses: 7310 "200": 7311 description: OK. 7312 content: 7313 application/json: 7314 schema: 7315 type: object 7316 "400": 7317 $ref: "#/components/responses/Err400" 7318 description: VALIDATION_ERROR — request validation failed. 7319 "401": 7320 $ref: "#/components/responses/Err401" 7321 description: UNAUTHORIZED — missing/invalid credentials. 7322 "429": 7323 $ref: "#/components/responses/Err429" 7324 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7325 "500": 7326 $ref: "#/components/responses/Err500" 7327 description: INTERNAL_ERROR — unexpected server error. 7328 /sessions/{id}: 7329 delete: 7330 operationId: DeleteSessionsById 7331 tags: 7332 - Sessions 7333 summary: Delete sessions by id 7334 security: 7335 - bearerAuth: [] 7336 parameters: 7337 - name: id 7338 in: path 7339 required: true 7340 schema: 7341 type: string 7342 - $ref: "#/components/parameters/IdempotencyKey" 7343 responses: 7344 "200": 7345 description: OK. 7346 content: 7347 application/json: 7348 schema: 7349 type: object 7350 "400": 7351 $ref: "#/components/responses/Err400" 7352 description: VALIDATION_ERROR — request validation failed. 7353 "401": 7354 $ref: "#/components/responses/Err401" 7355 description: UNAUTHORIZED — missing/invalid credentials. 7356 "429": 7357 $ref: "#/components/responses/Err429" 7358 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7359 "500": 7360 $ref: "#/components/responses/Err500" 7361 description: INTERNAL_ERROR — unexpected server error. 7362 /share/{slug}: 7363 get: 7364 operationId: GetShareBySlug 7365 tags: 7366 - Sharing 7367 summary: Get sharing by slug 7368 security: [] 7369 parameters: 7370 - name: slug 7371 in: path 7372 required: true 7373 schema: 7374 type: string 7375 responses: 7376 "200": 7377 description: OK. 7378 content: 7379 application/json: 7380 schema: 7381 type: object 7382 "429": 7383 $ref: "#/components/responses/Err429" 7384 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7385 "500": 7386 $ref: "#/components/responses/Err500" 7387 description: INTERNAL_ERROR — unexpected server error. 7388 /shares: 7389 post: 7390 operationId: PostShares 7391 tags: 7392 - Sharing 7393 summary: Create sharing 7394 security: 7395 - bearerAuth: [] 7396 parameters: 7397 - $ref: "#/components/parameters/IdempotencyKey" 7398 responses: 7399 "201": 7400 description: The created resource. 7401 content: 7402 application/json: 7403 schema: 7404 type: object 7405 "400": 7406 $ref: "#/components/responses/Err400" 7407 description: VALIDATION_ERROR — request validation failed. 7408 "401": 7409 $ref: "#/components/responses/Err401" 7410 description: UNAUTHORIZED — missing/invalid credentials. 7411 "403": 7412 $ref: "#/components/responses/Err403" 7413 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7414 "404": 7415 $ref: "#/components/responses/Err404" 7416 description: NOT_FOUND — resource does not exist for this caller. 7417 "409": 7418 $ref: "#/components/responses/Err409" 7419 description: CONFLICT — duplicate or state conflict. 7420 "429": 7421 $ref: "#/components/responses/Err429" 7422 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7423 "500": 7424 $ref: "#/components/responses/Err500" 7425 description: INTERNAL_ERROR — unexpected server error. 7426 /shares/{id}: 7427 delete: 7428 operationId: DeleteSharesById 7429 tags: 7430 - Sharing 7431 summary: Delete sharing by id 7432 security: 7433 - bearerAuth: [] 7434 parameters: 7435 - name: id 7436 in: path 7437 required: true 7438 schema: 7439 type: string 7440 - $ref: "#/components/parameters/IdempotencyKey" 7441 responses: 7442 "200": 7443 description: OK. 7444 content: 7445 application/json: 7446 schema: 7447 type: object 7448 "400": 7449 $ref: "#/components/responses/Err400" 7450 description: VALIDATION_ERROR — request validation failed. 7451 "401": 7452 $ref: "#/components/responses/Err401" 7453 description: UNAUTHORIZED — missing/invalid credentials. 7454 "403": 7455 $ref: "#/components/responses/Err403" 7456 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7457 "404": 7458 $ref: "#/components/responses/Err404" 7459 description: NOT_FOUND — resource does not exist for this caller. 7460 "429": 7461 $ref: "#/components/responses/Err429" 7462 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7463 "500": 7464 $ref: "#/components/responses/Err500" 7465 description: INTERNAL_ERROR — unexpected server error. 7466 /shares/{workspaceId}: 7467 get: 7468 operationId: GetSharesByWorkspaceId 7469 tags: 7470 - Sharing 7471 summary: Get sharing by workspaceId 7472 security: 7473 - bearerAuth: [] 7474 parameters: 7475 - name: workspaceId 7476 in: path 7477 required: true 7478 schema: 7479 type: string 7480 responses: 7481 "200": 7482 description: OK. 7483 content: 7484 application/json: 7485 schema: 7486 type: object 7487 "401": 7488 $ref: "#/components/responses/Err401" 7489 description: UNAUTHORIZED — missing/invalid credentials. 7490 "403": 7491 $ref: "#/components/responses/Err403" 7492 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7493 "404": 7494 $ref: "#/components/responses/Err404" 7495 description: NOT_FOUND — resource does not exist for this caller. 7496 "429": 7497 $ref: "#/components/responses/Err429" 7498 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7499 "500": 7500 $ref: "#/components/responses/Err500" 7501 description: INTERNAL_ERROR — unexpected server error. 7502 /templates/{id}/apply: 7503 post: 7504 operationId: PostTemplatesByIdApply 7505 tags: 7506 - Templates 7507 summary: Create templates by id 7508 security: 7509 - bearerAuth: [] 7510 parameters: 7511 - name: id 7512 in: path 7513 required: true 7514 schema: 7515 type: string 7516 - $ref: "#/components/parameters/IdempotencyKey" 7517 responses: 7518 "200": 7519 description: OK. 7520 content: 7521 application/json: 7522 schema: 7523 type: object 7524 "400": 7525 $ref: "#/components/responses/Err400" 7526 description: VALIDATION_ERROR — request validation failed. 7527 "401": 7528 $ref: "#/components/responses/Err401" 7529 description: UNAUTHORIZED — missing/invalid credentials. 7530 "403": 7531 $ref: "#/components/responses/Err403" 7532 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7533 "404": 7534 $ref: "#/components/responses/Err404" 7535 description: NOT_FOUND — resource does not exist for this caller. 7536 "429": 7537 $ref: "#/components/responses/Err429" 7538 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7539 "500": 7540 $ref: "#/components/responses/Err500" 7541 description: INTERNAL_ERROR — unexpected server error. 7542 /templates/{id}/preview: 7543 get: 7544 operationId: GetTemplatesByIdPreview 7545 tags: 7546 - Templates 7547 summary: Get templates by id 7548 security: 7549 - bearerAuth: [] 7550 parameters: 7551 - name: id 7552 in: path 7553 required: true 7554 schema: 7555 type: string 7556 responses: 7557 "200": 7558 description: OK. 7559 content: 7560 application/json: 7561 schema: 7562 type: object 7563 "401": 7564 $ref: "#/components/responses/Err401" 7565 description: UNAUTHORIZED — missing/invalid credentials. 7566 "403": 7567 $ref: "#/components/responses/Err403" 7568 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7569 "404": 7570 $ref: "#/components/responses/Err404" 7571 description: NOT_FOUND — resource does not exist for this caller. 7572 "429": 7573 $ref: "#/components/responses/Err429" 7574 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7575 "500": 7576 $ref: "#/components/responses/Err500" 7577 description: INTERNAL_ERROR — unexpected server error. 7578 /templates/{id}/versions: 7579 post: 7580 operationId: PostTemplatesByIdVersions 7581 tags: 7582 - Templates 7583 summary: Create templates by id 7584 security: 7585 - bearerAuth: [] 7586 parameters: 7587 - name: id 7588 in: path 7589 required: true 7590 schema: 7591 type: string 7592 - $ref: "#/components/parameters/IdempotencyKey" 7593 responses: 7594 "200": 7595 description: OK. 7596 content: 7597 application/json: 7598 schema: 7599 type: object 7600 "400": 7601 $ref: "#/components/responses/Err400" 7602 description: VALIDATION_ERROR — request validation failed. 7603 "401": 7604 $ref: "#/components/responses/Err401" 7605 description: UNAUTHORIZED — missing/invalid credentials. 7606 "403": 7607 $ref: "#/components/responses/Err403" 7608 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7609 "404": 7610 $ref: "#/components/responses/Err404" 7611 description: NOT_FOUND — resource does not exist for this caller. 7612 "429": 7613 $ref: "#/components/responses/Err429" 7614 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7615 "500": 7616 $ref: "#/components/responses/Err500" 7617 description: INTERNAL_ERROR — unexpected server error. 7618 get: 7619 operationId: GetTemplatesByIdVersions 7620 tags: 7621 - Templates 7622 summary: Get templates by id 7623 security: 7624 - bearerAuth: [] 7625 parameters: 7626 - name: id 7627 in: path 7628 required: true 7629 schema: 7630 type: string 7631 responses: 7632 "200": 7633 description: OK. 7634 content: 7635 application/json: 7636 schema: 7637 type: object 7638 "401": 7639 $ref: "#/components/responses/Err401" 7640 description: UNAUTHORIZED — missing/invalid credentials. 7641 "403": 7642 $ref: "#/components/responses/Err403" 7643 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7644 "404": 7645 $ref: "#/components/responses/Err404" 7646 description: NOT_FOUND — resource does not exist for this caller. 7647 "429": 7648 $ref: "#/components/responses/Err429" 7649 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7650 "500": 7651 $ref: "#/components/responses/Err500" 7652 description: INTERNAL_ERROR — unexpected server error. 7653 /templates/{id}/versions/{versionId}/restore: 7654 post: 7655 operationId: PostTemplatesByIdVersionsByVersionIdRestore 7656 tags: 7657 - Templates 7658 summary: Create templates by id + versionId 7659 security: 7660 - bearerAuth: [] 7661 parameters: 7662 - name: id 7663 in: path 7664 required: true 7665 schema: 7666 type: string 7667 - name: versionId 7668 in: path 7669 required: true 7670 schema: 7671 type: string 7672 - $ref: "#/components/parameters/IdempotencyKey" 7673 responses: 7674 "200": 7675 description: OK. 7676 content: 7677 application/json: 7678 schema: 7679 type: object 7680 "400": 7681 $ref: "#/components/responses/Err400" 7682 description: VALIDATION_ERROR — request validation failed. 7683 "401": 7684 $ref: "#/components/responses/Err401" 7685 description: UNAUTHORIZED — missing/invalid credentials. 7686 "403": 7687 $ref: "#/components/responses/Err403" 7688 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7689 "404": 7690 $ref: "#/components/responses/Err404" 7691 description: NOT_FOUND — resource does not exist for this caller. 7692 "429": 7693 $ref: "#/components/responses/Err429" 7694 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7695 "500": 7696 $ref: "#/components/responses/Err500" 7697 description: INTERNAL_ERROR — unexpected server error. 7698 /users: 7699 get: 7700 operationId: GetUsers 7701 tags: 7702 - Users 7703 summary: List users (workspace context) 7704 security: 7705 - bearerAuth: [] 7706 parameters: [] 7707 responses: 7708 "200": 7709 description: OK. 7710 content: 7711 application/json: 7712 schema: 7713 type: object 7714 "401": 7715 $ref: "#/components/responses/Err401" 7716 description: UNAUTHORIZED — missing/invalid credentials. 7717 "403": 7718 $ref: "#/components/responses/Err403" 7719 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7720 "404": 7721 $ref: "#/components/responses/Err404" 7722 description: NOT_FOUND — resource does not exist for this caller. 7723 "429": 7724 $ref: "#/components/responses/Err429" 7725 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7726 "500": 7727 $ref: "#/components/responses/Err500" 7728 description: INTERNAL_ERROR — unexpected server error. 7729 /users/me: 7730 get: 7731 operationId: GetUsersMe 7732 tags: 7733 - Users 7734 summary: Get the current user 7735 security: 7736 - bearerAuth: [] 7737 parameters: [] 7738 responses: 7739 "200": 7740 description: OK. 7741 content: 7742 application/json: 7743 schema: 7744 type: object 7745 "401": 7746 $ref: "#/components/responses/Err401" 7747 description: UNAUTHORIZED — missing/invalid credentials. 7748 "429": 7749 $ref: "#/components/responses/Err429" 7750 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7751 "500": 7752 $ref: "#/components/responses/Err500" 7753 description: INTERNAL_ERROR — unexpected server error. 7754 patch: 7755 operationId: PatchUsersMe 7756 tags: 7757 - Users 7758 summary: Update users 7759 security: 7760 - bearerAuth: [] 7761 parameters: 7762 - $ref: "#/components/parameters/IdempotencyKey" 7763 responses: 7764 "200": 7765 description: OK. 7766 content: 7767 application/json: 7768 schema: 7769 type: object 7770 "400": 7771 $ref: "#/components/responses/Err400" 7772 description: VALIDATION_ERROR — request validation failed. 7773 "401": 7774 $ref: "#/components/responses/Err401" 7775 description: UNAUTHORIZED — missing/invalid credentials. 7776 "409": 7777 $ref: "#/components/responses/Err409" 7778 description: CONFLICT — duplicate or state conflict. 7779 "429": 7780 $ref: "#/components/responses/Err429" 7781 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7782 "500": 7783 $ref: "#/components/responses/Err500" 7784 description: INTERNAL_ERROR — unexpected server error. 7785 /users/me/activity: 7786 get: 7787 operationId: GetUsersMeActivity 7788 tags: 7789 - Users 7790 summary: List users 7791 security: 7792 - bearerAuth: [] 7793 parameters: [] 7794 responses: 7795 "200": 7796 description: OK. 7797 content: 7798 application/json: 7799 schema: 7800 type: object 7801 "401": 7802 $ref: "#/components/responses/Err401" 7803 description: UNAUTHORIZED — missing/invalid credentials. 7804 "403": 7805 $ref: "#/components/responses/Err403" 7806 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7807 "404": 7808 $ref: "#/components/responses/Err404" 7809 description: NOT_FOUND — resource does not exist for this caller. 7810 "429": 7811 $ref: "#/components/responses/Err429" 7812 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7813 "500": 7814 $ref: "#/components/responses/Err500" 7815 description: INTERNAL_ERROR — unexpected server error. 7816 /users/me/profile: 7817 get: 7818 operationId: GetUsersMeProfile 7819 tags: 7820 - Users 7821 summary: List users 7822 security: 7823 - bearerAuth: [] 7824 parameters: [] 7825 responses: 7826 "200": 7827 description: OK. 7828 content: 7829 application/json: 7830 schema: 7831 type: object 7832 "401": 7833 $ref: "#/components/responses/Err401" 7834 description: UNAUTHORIZED — missing/invalid credentials. 7835 "429": 7836 $ref: "#/components/responses/Err429" 7837 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7838 "500": 7839 $ref: "#/components/responses/Err500" 7840 description: INTERNAL_ERROR — unexpected server error. 7841 /users/me/recent: 7842 put: 7843 operationId: PutUsersMeRecent 7844 tags: 7845 - Users 7846 summary: Replace users 7847 security: 7848 - bearerAuth: [] 7849 parameters: 7850 - $ref: "#/components/parameters/IdempotencyKey" 7851 responses: 7852 "200": 7853 description: OK. 7854 content: 7855 application/json: 7856 schema: 7857 type: object 7858 "400": 7859 $ref: "#/components/responses/Err400" 7860 description: VALIDATION_ERROR — request validation failed. 7861 "401": 7862 $ref: "#/components/responses/Err401" 7863 description: UNAUTHORIZED — missing/invalid credentials. 7864 "403": 7865 $ref: "#/components/responses/Err403" 7866 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7867 "404": 7868 $ref: "#/components/responses/Err404" 7869 description: NOT_FOUND — resource does not exist for this caller. 7870 "409": 7871 $ref: "#/components/responses/Err409" 7872 description: CONFLICT — duplicate or state conflict. 7873 "429": 7874 $ref: "#/components/responses/Err429" 7875 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7876 "500": 7877 $ref: "#/components/responses/Err500" 7878 description: INTERNAL_ERROR — unexpected server error. 7879 get: 7880 operationId: GetUsersMeRecent 7881 tags: 7882 - Users 7883 summary: List users 7884 security: 7885 - bearerAuth: [] 7886 parameters: [] 7887 responses: 7888 "200": 7889 description: OK. 7890 content: 7891 application/json: 7892 schema: 7893 type: object 7894 "401": 7895 $ref: "#/components/responses/Err401" 7896 description: UNAUTHORIZED — missing/invalid credentials. 7897 "403": 7898 $ref: "#/components/responses/Err403" 7899 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7900 "404": 7901 $ref: "#/components/responses/Err404" 7902 description: NOT_FOUND — resource does not exist for this caller. 7903 "429": 7904 $ref: "#/components/responses/Err429" 7905 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7906 "500": 7907 $ref: "#/components/responses/Err500" 7908 description: INTERNAL_ERROR — unexpected server error. 7909 /users/me/saved-searches: 7910 get: 7911 operationId: GetUsersMeSavedSearches 7912 tags: 7913 - Users 7914 summary: List users 7915 security: 7916 - bearerAuth: [] 7917 parameters: [] 7918 responses: 7919 "200": 7920 description: OK. 7921 content: 7922 application/json: 7923 schema: 7924 type: object 7925 "401": 7926 $ref: "#/components/responses/Err401" 7927 description: UNAUTHORIZED — missing/invalid credentials. 7928 "403": 7929 $ref: "#/components/responses/Err403" 7930 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7931 "404": 7932 $ref: "#/components/responses/Err404" 7933 description: NOT_FOUND — resource does not exist for this caller. 7934 "429": 7935 $ref: "#/components/responses/Err429" 7936 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7937 "500": 7938 $ref: "#/components/responses/Err500" 7939 description: INTERNAL_ERROR — unexpected server error. 7940 post: 7941 operationId: PostUsersMeSavedSearches 7942 tags: 7943 - Users 7944 summary: Create users 7945 security: 7946 - bearerAuth: [] 7947 parameters: 7948 - $ref: "#/components/parameters/IdempotencyKey" 7949 responses: 7950 "200": 7951 description: OK. 7952 content: 7953 application/json: 7954 schema: 7955 type: object 7956 "400": 7957 $ref: "#/components/responses/Err400" 7958 description: VALIDATION_ERROR — request validation failed. 7959 "401": 7960 $ref: "#/components/responses/Err401" 7961 description: UNAUTHORIZED — missing/invalid credentials. 7962 "403": 7963 $ref: "#/components/responses/Err403" 7964 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 7965 "404": 7966 $ref: "#/components/responses/Err404" 7967 description: NOT_FOUND — resource does not exist for this caller. 7968 "429": 7969 $ref: "#/components/responses/Err429" 7970 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 7971 "500": 7972 $ref: "#/components/responses/Err500" 7973 description: INTERNAL_ERROR — unexpected server error. 7974 /users/me/saved-searches/{id}: 7975 get: 7976 operationId: GetUsersMeSavedSearchesById 7977 tags: 7978 - Users 7979 summary: Get users by id 7980 security: 7981 - bearerAuth: [] 7982 parameters: 7983 - name: id 7984 in: path 7985 required: true 7986 schema: 7987 type: string 7988 responses: 7989 "200": 7990 description: OK. 7991 content: 7992 application/json: 7993 schema: 7994 type: object 7995 "401": 7996 $ref: "#/components/responses/Err401" 7997 description: UNAUTHORIZED — missing/invalid credentials. 7998 "403": 7999 $ref: "#/components/responses/Err403" 8000 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8001 "404": 8002 $ref: "#/components/responses/Err404" 8003 description: NOT_FOUND — resource does not exist for this caller. 8004 "429": 8005 $ref: "#/components/responses/Err429" 8006 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8007 "500": 8008 $ref: "#/components/responses/Err500" 8009 description: INTERNAL_ERROR — unexpected server error. 8010 patch: 8011 operationId: PatchUsersMeSavedSearchesById 8012 tags: 8013 - Users 8014 summary: Update users by id 8015 security: 8016 - bearerAuth: [] 8017 parameters: 8018 - name: id 8019 in: path 8020 required: true 8021 schema: 8022 type: string 8023 - $ref: "#/components/parameters/IdempotencyKey" 8024 responses: 8025 "200": 8026 description: OK. 8027 content: 8028 application/json: 8029 schema: 8030 type: object 8031 "400": 8032 $ref: "#/components/responses/Err400" 8033 description: VALIDATION_ERROR — request validation failed. 8034 "401": 8035 $ref: "#/components/responses/Err401" 8036 description: UNAUTHORIZED — missing/invalid credentials. 8037 "403": 8038 $ref: "#/components/responses/Err403" 8039 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8040 "404": 8041 $ref: "#/components/responses/Err404" 8042 description: NOT_FOUND — resource does not exist for this caller. 8043 "409": 8044 $ref: "#/components/responses/Err409" 8045 description: CONFLICT — duplicate or state conflict. 8046 "429": 8047 $ref: "#/components/responses/Err429" 8048 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8049 "500": 8050 $ref: "#/components/responses/Err500" 8051 description: INTERNAL_ERROR — unexpected server error. 8052 delete: 8053 operationId: DeleteUsersMeSavedSearchesById 8054 tags: 8055 - Users 8056 summary: Delete users by id 8057 security: 8058 - bearerAuth: [] 8059 parameters: 8060 - name: id 8061 in: path 8062 required: true 8063 schema: 8064 type: string 8065 - $ref: "#/components/parameters/IdempotencyKey" 8066 responses: 8067 "200": 8068 description: OK. 8069 content: 8070 application/json: 8071 schema: 8072 type: object 8073 "400": 8074 $ref: "#/components/responses/Err400" 8075 description: VALIDATION_ERROR — request validation failed. 8076 "401": 8077 $ref: "#/components/responses/Err401" 8078 description: UNAUTHORIZED — missing/invalid credentials. 8079 "403": 8080 $ref: "#/components/responses/Err403" 8081 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8082 "404": 8083 $ref: "#/components/responses/Err404" 8084 description: NOT_FOUND — resource does not exist for this caller. 8085 "429": 8086 $ref: "#/components/responses/Err429" 8087 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8088 "500": 8089 $ref: "#/components/responses/Err500" 8090 description: INTERNAL_ERROR — unexpected server error. 8091 /webhooks/incoming/{webhookId}: 8092 post: 8093 operationId: PostWebhooksIncomingByWebhookId 8094 tags: 8095 - Webhooks 8096 summary: Receive an incoming automation webhook payload 8097 security: [] 8098 parameters: 8099 - name: webhookId 8100 in: path 8101 required: true 8102 schema: 8103 type: string 8104 - $ref: "#/components/parameters/IdempotencyKey" 8105 responses: 8106 "200": 8107 description: OK. 8108 content: 8109 application/json: 8110 schema: 8111 type: object 8112 "400": 8113 $ref: "#/components/responses/Err400" 8114 description: VALIDATION_ERROR — request validation failed. 8115 "429": 8116 $ref: "#/components/responses/Err429" 8117 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8118 "500": 8119 $ref: "#/components/responses/Err500" 8120 description: INTERNAL_ERROR — unexpected server error. 8121 /workspaces: 8122 get: 8123 operationId: GetWorkspaces 8124 tags: 8125 - Workspaces 8126 summary: List workspaces 8127 security: 8128 - bearerAuth: [] 8129 parameters: [] 8130 responses: 8131 "200": 8132 description: OK. 8133 content: 8134 application/json: 8135 schema: 8136 type: object 8137 "401": 8138 $ref: "#/components/responses/Err401" 8139 description: UNAUTHORIZED — missing/invalid credentials. 8140 "403": 8141 $ref: "#/components/responses/Err403" 8142 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8143 "404": 8144 $ref: "#/components/responses/Err404" 8145 description: NOT_FOUND — resource does not exist for this caller. 8146 "429": 8147 $ref: "#/components/responses/Err429" 8148 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8149 "500": 8150 $ref: "#/components/responses/Err500" 8151 description: INTERNAL_ERROR — unexpected server error. 8152 post: 8153 operationId: PostWorkspaces 8154 tags: 8155 - Workspaces 8156 summary: Create workspaces 8157 security: 8158 - bearerAuth: [] 8159 parameters: 8160 - $ref: "#/components/parameters/IdempotencyKey" 8161 responses: 8162 "201": 8163 description: The created resource. 8164 content: 8165 application/json: 8166 schema: 8167 type: object 8168 "400": 8169 $ref: "#/components/responses/Err400" 8170 description: VALIDATION_ERROR — request validation failed. 8171 "401": 8172 $ref: "#/components/responses/Err401" 8173 description: UNAUTHORIZED — missing/invalid credentials. 8174 "403": 8175 $ref: "#/components/responses/Err403" 8176 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8177 "404": 8178 $ref: "#/components/responses/Err404" 8179 description: NOT_FOUND — resource does not exist for this caller. 8180 "409": 8181 $ref: "#/components/responses/Err409" 8182 description: CONFLICT — duplicate or state conflict. 8183 "429": 8184 $ref: "#/components/responses/Err429" 8185 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8186 "500": 8187 $ref: "#/components/responses/Err500" 8188 description: INTERNAL_ERROR — unexpected server error. 8189 /workspaces/{id}: 8190 get: 8191 operationId: GetWorkspacesById 8192 tags: 8193 - Workspaces 8194 summary: Get workspaces by id 8195 security: 8196 - bearerAuth: [] 8197 parameters: 8198 - name: id 8199 in: path 8200 required: true 8201 schema: 8202 type: string 8203 responses: 8204 "200": 8205 description: OK. 8206 content: 8207 application/json: 8208 schema: 8209 type: object 8210 "401": 8211 $ref: "#/components/responses/Err401" 8212 description: UNAUTHORIZED — missing/invalid credentials. 8213 "403": 8214 $ref: "#/components/responses/Err403" 8215 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8216 "404": 8217 $ref: "#/components/responses/Err404" 8218 description: NOT_FOUND — resource does not exist for this caller. 8219 "429": 8220 $ref: "#/components/responses/Err429" 8221 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8222 "500": 8223 $ref: "#/components/responses/Err500" 8224 description: INTERNAL_ERROR — unexpected server error. 8225 patch: 8226 operationId: PatchWorkspacesById 8227 tags: 8228 - Workspaces 8229 summary: Update workspaces by id 8230 security: 8231 - bearerAuth: [] 8232 parameters: 8233 - name: id 8234 in: path 8235 required: true 8236 schema: 8237 type: string 8238 - $ref: "#/components/parameters/IdempotencyKey" 8239 responses: 8240 "200": 8241 description: OK. 8242 content: 8243 application/json: 8244 schema: 8245 type: object 8246 "400": 8247 $ref: "#/components/responses/Err400" 8248 description: VALIDATION_ERROR — request validation failed. 8249 "401": 8250 $ref: "#/components/responses/Err401" 8251 description: UNAUTHORIZED — missing/invalid credentials. 8252 "403": 8253 $ref: "#/components/responses/Err403" 8254 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8255 "404": 8256 $ref: "#/components/responses/Err404" 8257 description: NOT_FOUND — resource does not exist for this caller. 8258 "409": 8259 $ref: "#/components/responses/Err409" 8260 description: CONFLICT — duplicate or state conflict. 8261 "429": 8262 $ref: "#/components/responses/Err429" 8263 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8264 "500": 8265 $ref: "#/components/responses/Err500" 8266 description: INTERNAL_ERROR — unexpected server error. 8267 delete: 8268 operationId: DeleteWorkspacesById 8269 tags: 8270 - Workspaces 8271 summary: Delete workspaces by id 8272 security: 8273 - bearerAuth: [] 8274 parameters: 8275 - name: id 8276 in: path 8277 required: true 8278 schema: 8279 type: string 8280 - $ref: "#/components/parameters/IdempotencyKey" 8281 responses: 8282 "200": 8283 description: OK. 8284 content: 8285 application/json: 8286 schema: 8287 type: object 8288 "400": 8289 $ref: "#/components/responses/Err400" 8290 description: VALIDATION_ERROR — request validation failed. 8291 "401": 8292 $ref: "#/components/responses/Err401" 8293 description: UNAUTHORIZED — missing/invalid credentials. 8294 "403": 8295 $ref: "#/components/responses/Err403" 8296 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8297 "404": 8298 $ref: "#/components/responses/Err404" 8299 description: NOT_FOUND — resource does not exist for this caller. 8300 "429": 8301 $ref: "#/components/responses/Err429" 8302 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8303 "500": 8304 $ref: "#/components/responses/Err500" 8305 description: INTERNAL_ERROR — unexpected server error. 8306 /workspaces/{id}/activity: 8307 get: 8308 operationId: GetWorkspacesByIdActivity 8309 tags: 8310 - Workspaces 8311 summary: Get workspaces by id 8312 security: 8313 - bearerAuth: [] 8314 parameters: 8315 - name: id 8316 in: path 8317 required: true 8318 schema: 8319 type: string 8320 responses: 8321 "200": 8322 description: OK. 8323 content: 8324 application/json: 8325 schema: 8326 type: object 8327 "401": 8328 $ref: "#/components/responses/Err401" 8329 description: UNAUTHORIZED — missing/invalid credentials. 8330 "403": 8331 $ref: "#/components/responses/Err403" 8332 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8333 "404": 8334 $ref: "#/components/responses/Err404" 8335 description: NOT_FOUND — resource does not exist for this caller. 8336 "429": 8337 $ref: "#/components/responses/Err429" 8338 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8339 "500": 8340 $ref: "#/components/responses/Err500" 8341 description: INTERNAL_ERROR — unexpected server error. 8342 /workspaces/{id}/archive: 8343 post: 8344 operationId: PostWorkspacesByIdArchive 8345 tags: 8346 - Workspaces 8347 summary: Create workspaces by id 8348 security: 8349 - bearerAuth: [] 8350 parameters: 8351 - name: id 8352 in: path 8353 required: true 8354 schema: 8355 type: string 8356 - $ref: "#/components/parameters/IdempotencyKey" 8357 responses: 8358 "200": 8359 description: OK. 8360 content: 8361 application/json: 8362 schema: 8363 type: object 8364 "400": 8365 $ref: "#/components/responses/Err400" 8366 description: VALIDATION_ERROR — request validation failed. 8367 "401": 8368 $ref: "#/components/responses/Err401" 8369 description: UNAUTHORIZED — missing/invalid credentials. 8370 "403": 8371 $ref: "#/components/responses/Err403" 8372 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8373 "404": 8374 $ref: "#/components/responses/Err404" 8375 description: NOT_FOUND — resource does not exist for this caller. 8376 "429": 8377 $ref: "#/components/responses/Err429" 8378 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8379 "500": 8380 $ref: "#/components/responses/Err500" 8381 description: INTERNAL_ERROR — unexpected server error. 8382 /workspaces/{id}/archive/restore: 8383 post: 8384 operationId: PostWorkspacesByIdArchiveRestore 8385 tags: 8386 - Workspaces 8387 summary: Create workspaces by id 8388 security: 8389 - bearerAuth: [] 8390 parameters: 8391 - name: id 8392 in: path 8393 required: true 8394 schema: 8395 type: string 8396 - $ref: "#/components/parameters/IdempotencyKey" 8397 responses: 8398 "200": 8399 description: OK. 8400 content: 8401 application/json: 8402 schema: 8403 type: object 8404 "400": 8405 $ref: "#/components/responses/Err400" 8406 description: VALIDATION_ERROR — request validation failed. 8407 "401": 8408 $ref: "#/components/responses/Err401" 8409 description: UNAUTHORIZED — missing/invalid credentials. 8410 "403": 8411 $ref: "#/components/responses/Err403" 8412 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8413 "404": 8414 $ref: "#/components/responses/Err404" 8415 description: NOT_FOUND — resource does not exist for this caller. 8416 "429": 8417 $ref: "#/components/responses/Err429" 8418 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8419 "500": 8420 $ref: "#/components/responses/Err500" 8421 description: INTERNAL_ERROR — unexpected server error. 8422 /workspaces/{id}/databases: 8423 get: 8424 operationId: GetWorkspacesByIdDatabases 8425 tags: 8426 - Workspaces 8427 summary: Get workspaces by id 8428 security: 8429 - bearerAuth: [] 8430 parameters: 8431 - name: id 8432 in: path 8433 required: true 8434 schema: 8435 type: string 8436 responses: 8437 "200": 8438 description: OK. 8439 content: 8440 application/json: 8441 schema: 8442 type: object 8443 "401": 8444 $ref: "#/components/responses/Err401" 8445 description: UNAUTHORIZED — missing/invalid credentials. 8446 "403": 8447 $ref: "#/components/responses/Err403" 8448 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8449 "404": 8450 $ref: "#/components/responses/Err404" 8451 description: NOT_FOUND — resource does not exist for this caller. 8452 "429": 8453 $ref: "#/components/responses/Err429" 8454 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8455 "500": 8456 $ref: "#/components/responses/Err500" 8457 description: INTERNAL_ERROR — unexpected server error. 8458 /workspaces/{id}/members: 8459 get: 8460 operationId: GetWorkspacesByIdMembers 8461 tags: 8462 - Workspaces 8463 summary: Get workspaces by id 8464 security: 8465 - bearerAuth: [] 8466 parameters: 8467 - name: id 8468 in: path 8469 required: true 8470 schema: 8471 type: string 8472 responses: 8473 "200": 8474 description: OK. 8475 content: 8476 application/json: 8477 schema: 8478 type: object 8479 "401": 8480 $ref: "#/components/responses/Err401" 8481 description: UNAUTHORIZED — missing/invalid credentials. 8482 "403": 8483 $ref: "#/components/responses/Err403" 8484 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8485 "404": 8486 $ref: "#/components/responses/Err404" 8487 description: NOT_FOUND — resource does not exist for this caller. 8488 "429": 8489 $ref: "#/components/responses/Err429" 8490 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8491 "500": 8492 $ref: "#/components/responses/Err500" 8493 description: INTERNAL_ERROR — unexpected server error. 8494 /workspaces/{id}/members/{userId}: 8495 patch: 8496 operationId: PatchWorkspacesByIdMembersByUserId 8497 tags: 8498 - Workspaces 8499 summary: Update workspaces by id + userId 8500 security: 8501 - bearerAuth: [] 8502 parameters: 8503 - name: id 8504 in: path 8505 required: true 8506 schema: 8507 type: string 8508 - name: userId 8509 in: path 8510 required: true 8511 schema: 8512 type: string 8513 - $ref: "#/components/parameters/IdempotencyKey" 8514 responses: 8515 "200": 8516 description: OK. 8517 content: 8518 application/json: 8519 schema: 8520 type: object 8521 "400": 8522 $ref: "#/components/responses/Err400" 8523 description: VALIDATION_ERROR — request validation failed. 8524 "401": 8525 $ref: "#/components/responses/Err401" 8526 description: UNAUTHORIZED — missing/invalid credentials. 8527 "403": 8528 $ref: "#/components/responses/Err403" 8529 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8530 "404": 8531 $ref: "#/components/responses/Err404" 8532 description: NOT_FOUND — resource does not exist for this caller. 8533 "409": 8534 $ref: "#/components/responses/Err409" 8535 description: CONFLICT — duplicate or state conflict. 8536 "429": 8537 $ref: "#/components/responses/Err429" 8538 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8539 "500": 8540 $ref: "#/components/responses/Err500" 8541 description: INTERNAL_ERROR — unexpected server error. 8542 delete: 8543 operationId: DeleteWorkspacesByIdMembersByUserId 8544 tags: 8545 - Workspaces 8546 summary: Delete workspaces by id + userId 8547 security: 8548 - bearerAuth: [] 8549 parameters: 8550 - name: id 8551 in: path 8552 required: true 8553 schema: 8554 type: string 8555 - name: userId 8556 in: path 8557 required: true 8558 schema: 8559 type: string 8560 - $ref: "#/components/parameters/IdempotencyKey" 8561 responses: 8562 "200": 8563 description: OK. 8564 content: 8565 application/json: 8566 schema: 8567 type: object 8568 "400": 8569 $ref: "#/components/responses/Err400" 8570 description: VALIDATION_ERROR — request validation failed. 8571 "401": 8572 $ref: "#/components/responses/Err401" 8573 description: UNAUTHORIZED — missing/invalid credentials. 8574 "403": 8575 $ref: "#/components/responses/Err403" 8576 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8577 "404": 8578 $ref: "#/components/responses/Err404" 8579 description: NOT_FOUND — resource does not exist for this caller. 8580 "429": 8581 $ref: "#/components/responses/Err429" 8582 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8583 "500": 8584 $ref: "#/components/responses/Err500" 8585 description: INTERNAL_ERROR — unexpected server error. 8586 /workspaces/{id}/members/invites: 8587 post: 8588 operationId: PostWorkspacesByIdMembersInvites 8589 tags: 8590 - Workspaces 8591 summary: Create workspaces by id 8592 security: 8593 - bearerAuth: [] 8594 parameters: 8595 - name: id 8596 in: path 8597 required: true 8598 schema: 8599 type: string 8600 - $ref: "#/components/parameters/IdempotencyKey" 8601 responses: 8602 "201": 8603 description: The created resource. 8604 content: 8605 application/json: 8606 schema: 8607 type: object 8608 "400": 8609 $ref: "#/components/responses/Err400" 8610 description: VALIDATION_ERROR — request validation failed. 8611 "401": 8612 $ref: "#/components/responses/Err401" 8613 description: UNAUTHORIZED — missing/invalid credentials. 8614 "403": 8615 $ref: "#/components/responses/Err403" 8616 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8617 "404": 8618 $ref: "#/components/responses/Err404" 8619 description: NOT_FOUND — resource does not exist for this caller. 8620 "409": 8621 $ref: "#/components/responses/Err409" 8622 description: CONFLICT — duplicate or state conflict. 8623 "429": 8624 $ref: "#/components/responses/Err429" 8625 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8626 "500": 8627 $ref: "#/components/responses/Err500" 8628 description: INTERNAL_ERROR — unexpected server error. 8629 /workspaces/{id}/members/invites/{inviteId}/accept: 8630 post: 8631 operationId: PostWorkspacesByIdMembersInvitesByInviteIdAccept 8632 tags: 8633 - Workspaces 8634 summary: Create workspaces by id + inviteId 8635 security: 8636 - bearerAuth: [] 8637 parameters: 8638 - name: id 8639 in: path 8640 required: true 8641 schema: 8642 type: string 8643 - name: inviteId 8644 in: path 8645 required: true 8646 schema: 8647 type: string 8648 - $ref: "#/components/parameters/IdempotencyKey" 8649 responses: 8650 "200": 8651 description: OK. 8652 content: 8653 application/json: 8654 schema: 8655 type: object 8656 "400": 8657 $ref: "#/components/responses/Err400" 8658 description: VALIDATION_ERROR — request validation failed. 8659 "401": 8660 $ref: "#/components/responses/Err401" 8661 description: UNAUTHORIZED — missing/invalid credentials. 8662 "403": 8663 $ref: "#/components/responses/Err403" 8664 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8665 "404": 8666 $ref: "#/components/responses/Err404" 8667 description: NOT_FOUND — resource does not exist for this caller. 8668 "429": 8669 $ref: "#/components/responses/Err429" 8670 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8671 "500": 8672 $ref: "#/components/responses/Err500" 8673 description: INTERNAL_ERROR — unexpected server error. 8674 /workspaces/{id}/stats: 8675 get: 8676 operationId: GetWorkspacesByIdStats 8677 tags: 8678 - Workspaces 8679 summary: Get workspaces by id 8680 security: 8681 - bearerAuth: [] 8682 parameters: 8683 - name: id 8684 in: path 8685 required: true 8686 schema: 8687 type: string 8688 responses: 8689 "200": 8690 description: OK. 8691 content: 8692 application/json: 8693 schema: 8694 type: object 8695 "401": 8696 $ref: "#/components/responses/Err401" 8697 description: UNAUTHORIZED — missing/invalid credentials. 8698 "403": 8699 $ref: "#/components/responses/Err403" 8700 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8701 "404": 8702 $ref: "#/components/responses/Err404" 8703 description: NOT_FOUND — resource does not exist for this caller. 8704 "429": 8705 $ref: "#/components/responses/Err429" 8706 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8707 "500": 8708 $ref: "#/components/responses/Err500" 8709 description: INTERNAL_ERROR — unexpected server error. 8710 /workspaces/{id}/transfer: 8711 post: 8712 operationId: PostWorkspacesByIdTransfer 8713 tags: 8714 - Workspaces 8715 summary: Create workspaces by id 8716 security: 8717 - bearerAuth: [] 8718 parameters: 8719 - name: id 8720 in: path 8721 required: true 8722 schema: 8723 type: string 8724 - $ref: "#/components/parameters/IdempotencyKey" 8725 responses: 8726 "200": 8727 description: OK. 8728 content: 8729 application/json: 8730 schema: 8731 type: object 8732 "400": 8733 $ref: "#/components/responses/Err400" 8734 description: VALIDATION_ERROR — request validation failed. 8735 "401": 8736 $ref: "#/components/responses/Err401" 8737 description: UNAUTHORIZED — missing/invalid credentials. 8738 "403": 8739 $ref: "#/components/responses/Err403" 8740 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8741 "404": 8742 $ref: "#/components/responses/Err404" 8743 description: NOT_FOUND — resource does not exist for this caller. 8744 "429": 8745 $ref: "#/components/responses/Err429" 8746 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8747 "500": 8748 $ref: "#/components/responses/Err500" 8749 description: INTERNAL_ERROR — unexpected server error. 8750 /workspaces/{id}/usage: 8751 get: 8752 operationId: GetWorkspacesByIdUsage 8753 tags: 8754 - Workspaces 8755 summary: Get workspaces by id 8756 security: 8757 - bearerAuth: [] 8758 parameters: 8759 - name: id 8760 in: path 8761 required: true 8762 schema: 8763 type: string 8764 responses: 8765 "200": 8766 description: OK. 8767 content: 8768 application/json: 8769 schema: 8770 type: object 8771 "401": 8772 $ref: "#/components/responses/Err401" 8773 description: UNAUTHORIZED — missing/invalid credentials. 8774 "403": 8775 $ref: "#/components/responses/Err403" 8776 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8777 "404": 8778 $ref: "#/components/responses/Err404" 8779 description: NOT_FOUND — resource does not exist for this caller. 8780 "429": 8781 $ref: "#/components/responses/Err429" 8782 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8783 "500": 8784 $ref: "#/components/responses/Err500" 8785 description: INTERNAL_ERROR — unexpected server error. 8786 /workspaces/{workspaceId}/ai/assistant/apply-metadata: 8787 post: 8788 operationId: PostWorkspacesByWorkspaceIdAiAssistantApplyMetadata 8789 tags: 8790 - AI 8791 summary: Create ai by workspaceId 8792 security: 8793 - bearerAuth: [] 8794 parameters: 8795 - name: workspaceId 8796 in: path 8797 required: true 8798 schema: 8799 type: string 8800 - $ref: "#/components/parameters/FactoryWorkspace" 8801 - $ref: "#/components/parameters/IdempotencyKey" 8802 responses: 8803 "200": 8804 description: OK. 8805 content: 8806 application/json: 8807 schema: 8808 type: object 8809 "400": 8810 $ref: "#/components/responses/Err400" 8811 description: VALIDATION_ERROR — request validation failed. 8812 "401": 8813 $ref: "#/components/responses/Err401" 8814 description: UNAUTHORIZED — missing/invalid credentials. 8815 "403": 8816 $ref: "#/components/responses/Err403" 8817 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8818 "404": 8819 $ref: "#/components/responses/Err404" 8820 description: NOT_FOUND — resource does not exist for this caller. 8821 "429": 8822 $ref: "#/components/responses/Err429" 8823 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8824 "500": 8825 $ref: "#/components/responses/Err500" 8826 description: INTERNAL_ERROR — unexpected server error. 8827 /workspaces/{workspaceId}/ai/assistant/extract-actions: 8828 post: 8829 operationId: PostWorkspacesByWorkspaceIdAiAssistantExtractActions 8830 tags: 8831 - AI 8832 summary: Create ai by workspaceId 8833 security: 8834 - bearerAuth: [] 8835 parameters: 8836 - name: workspaceId 8837 in: path 8838 required: true 8839 schema: 8840 type: string 8841 - $ref: "#/components/parameters/FactoryWorkspace" 8842 - $ref: "#/components/parameters/IdempotencyKey" 8843 responses: 8844 "200": 8845 description: OK. 8846 content: 8847 application/json: 8848 schema: 8849 type: object 8850 "400": 8851 $ref: "#/components/responses/Err400" 8852 description: VALIDATION_ERROR — request validation failed. 8853 "401": 8854 $ref: "#/components/responses/Err401" 8855 description: UNAUTHORIZED — missing/invalid credentials. 8856 "403": 8857 $ref: "#/components/responses/Err403" 8858 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8859 "404": 8860 $ref: "#/components/responses/Err404" 8861 description: NOT_FOUND — resource does not exist for this caller. 8862 "429": 8863 $ref: "#/components/responses/Err429" 8864 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8865 "500": 8866 $ref: "#/components/responses/Err500" 8867 description: INTERNAL_ERROR — unexpected server error. 8868 /workspaces/{workspaceId}/ai/assistant/find-duplicates: 8869 post: 8870 operationId: PostWorkspacesByWorkspaceIdAiAssistantFindDuplicates 8871 tags: 8872 - AI 8873 summary: Create ai by workspaceId 8874 security: 8875 - bearerAuth: [] 8876 parameters: 8877 - name: workspaceId 8878 in: path 8879 required: true 8880 schema: 8881 type: string 8882 - $ref: "#/components/parameters/FactoryWorkspace" 8883 - $ref: "#/components/parameters/IdempotencyKey" 8884 responses: 8885 "200": 8886 description: OK. 8887 content: 8888 application/json: 8889 schema: 8890 type: object 8891 "400": 8892 $ref: "#/components/responses/Err400" 8893 description: VALIDATION_ERROR — request validation failed. 8894 "401": 8895 $ref: "#/components/responses/Err401" 8896 description: UNAUTHORIZED — missing/invalid credentials. 8897 "403": 8898 $ref: "#/components/responses/Err403" 8899 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8900 "404": 8901 $ref: "#/components/responses/Err404" 8902 description: NOT_FOUND — resource does not exist for this caller. 8903 "429": 8904 $ref: "#/components/responses/Err429" 8905 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8906 "500": 8907 $ref: "#/components/responses/Err500" 8908 description: INTERNAL_ERROR — unexpected server error. 8909 /workspaces/{workspaceId}/ai/assistant/find-stale: 8910 post: 8911 operationId: PostWorkspacesByWorkspaceIdAiAssistantFindStale 8912 tags: 8913 - AI 8914 summary: Create ai by workspaceId 8915 security: 8916 - bearerAuth: [] 8917 parameters: 8918 - name: workspaceId 8919 in: path 8920 required: true 8921 schema: 8922 type: string 8923 - $ref: "#/components/parameters/FactoryWorkspace" 8924 - $ref: "#/components/parameters/IdempotencyKey" 8925 responses: 8926 "200": 8927 description: OK. 8928 content: 8929 application/json: 8930 schema: 8931 type: object 8932 "400": 8933 $ref: "#/components/responses/Err400" 8934 description: VALIDATION_ERROR — request validation failed. 8935 "401": 8936 $ref: "#/components/responses/Err401" 8937 description: UNAUTHORIZED — missing/invalid credentials. 8938 "403": 8939 $ref: "#/components/responses/Err403" 8940 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8941 "404": 8942 $ref: "#/components/responses/Err404" 8943 description: NOT_FOUND — resource does not exist for this caller. 8944 "429": 8945 $ref: "#/components/responses/Err429" 8946 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8947 "500": 8948 $ref: "#/components/responses/Err500" 8949 description: INTERNAL_ERROR — unexpected server error. 8950 /workspaces/{workspaceId}/ai/assistant/generate-faqs: 8951 post: 8952 operationId: PostWorkspacesByWorkspaceIdAiAssistantGenerateFaqs 8953 tags: 8954 - AI 8955 summary: Create ai by workspaceId 8956 security: 8957 - bearerAuth: [] 8958 parameters: 8959 - name: workspaceId 8960 in: path 8961 required: true 8962 schema: 8963 type: string 8964 - $ref: "#/components/parameters/FactoryWorkspace" 8965 - $ref: "#/components/parameters/IdempotencyKey" 8966 responses: 8967 "200": 8968 description: OK. 8969 content: 8970 application/json: 8971 schema: 8972 type: object 8973 "400": 8974 $ref: "#/components/responses/Err400" 8975 description: VALIDATION_ERROR — request validation failed. 8976 "401": 8977 $ref: "#/components/responses/Err401" 8978 description: UNAUTHORIZED — missing/invalid credentials. 8979 "403": 8980 $ref: "#/components/responses/Err403" 8981 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 8982 "404": 8983 $ref: "#/components/responses/Err404" 8984 description: NOT_FOUND — resource does not exist for this caller. 8985 "429": 8986 $ref: "#/components/responses/Err429" 8987 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 8988 "500": 8989 $ref: "#/components/responses/Err500" 8990 description: INTERNAL_ERROR — unexpected server error. 8991 /workspaces/{workspaceId}/ai/assistant/suggest-metadata: 8992 post: 8993 operationId: PostWorkspacesByWorkspaceIdAiAssistantSuggestMetadata 8994 tags: 8995 - AI 8996 summary: Create ai by workspaceId 8997 security: 8998 - bearerAuth: [] 8999 parameters: 9000 - name: workspaceId 9001 in: path 9002 required: true 9003 schema: 9004 type: string 9005 - $ref: "#/components/parameters/FactoryWorkspace" 9006 - $ref: "#/components/parameters/IdempotencyKey" 9007 responses: 9008 "200": 9009 description: OK. 9010 content: 9011 application/json: 9012 schema: 9013 type: object 9014 "400": 9015 $ref: "#/components/responses/Err400" 9016 description: VALIDATION_ERROR — request validation failed. 9017 "401": 9018 $ref: "#/components/responses/Err401" 9019 description: UNAUTHORIZED — missing/invalid credentials. 9020 "403": 9021 $ref: "#/components/responses/Err403" 9022 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9023 "404": 9024 $ref: "#/components/responses/Err404" 9025 description: NOT_FOUND — resource does not exist for this caller. 9026 "429": 9027 $ref: "#/components/responses/Err429" 9028 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9029 "500": 9030 $ref: "#/components/responses/Err500" 9031 description: INTERNAL_ERROR — unexpected server error. 9032 /workspaces/{workspaceId}/ai/chat: 9033 post: 9034 operationId: PostWorkspacesByWorkspaceIdAiChat 9035 tags: 9036 - AI 9037 summary: AI chat (user-identity only) 9038 security: 9039 - bearerAuth: [] 9040 parameters: 9041 - name: workspaceId 9042 in: path 9043 required: true 9044 schema: 9045 type: string 9046 - $ref: "#/components/parameters/FactoryWorkspace" 9047 - $ref: "#/components/parameters/IdempotencyKey" 9048 responses: 9049 "200": 9050 description: OK. 9051 content: 9052 application/json: 9053 schema: 9054 type: object 9055 "400": 9056 $ref: "#/components/responses/Err400" 9057 description: VALIDATION_ERROR — request validation failed. 9058 "401": 9059 $ref: "#/components/responses/Err401" 9060 description: UNAUTHORIZED — missing/invalid credentials. 9061 "403": 9062 $ref: "#/components/responses/Err403" 9063 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9064 "404": 9065 $ref: "#/components/responses/Err404" 9066 description: NOT_FOUND — resource does not exist for this caller. 9067 "429": 9068 $ref: "#/components/responses/Err429" 9069 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9070 "500": 9071 $ref: "#/components/responses/Err500" 9072 description: INTERNAL_ERROR — unexpected server error. 9073 /workspaces/{workspaceId}/ai/conversations: 9074 get: 9075 operationId: GetWorkspacesByWorkspaceIdAiConversations 9076 tags: 9077 - AI 9078 summary: List AI conversations (user-identity only) 9079 security: 9080 - bearerAuth: [] 9081 parameters: 9082 - name: workspaceId 9083 in: path 9084 required: true 9085 schema: 9086 type: string 9087 - $ref: "#/components/parameters/FactoryWorkspace" 9088 responses: 9089 "200": 9090 description: OK. 9091 content: 9092 application/json: 9093 schema: 9094 type: object 9095 "401": 9096 $ref: "#/components/responses/Err401" 9097 description: UNAUTHORIZED — missing/invalid credentials. 9098 "403": 9099 $ref: "#/components/responses/Err403" 9100 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9101 "404": 9102 $ref: "#/components/responses/Err404" 9103 description: NOT_FOUND — resource does not exist for this caller. 9104 "429": 9105 $ref: "#/components/responses/Err429" 9106 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9107 "500": 9108 $ref: "#/components/responses/Err500" 9109 description: INTERNAL_ERROR — unexpected server error. 9110 post: 9111 operationId: PostWorkspacesByWorkspaceIdAiConversations 9112 tags: 9113 - AI 9114 summary: Create an AI conversation (user-identity only) 9115 security: 9116 - bearerAuth: [] 9117 parameters: 9118 - name: workspaceId 9119 in: path 9120 required: true 9121 schema: 9122 type: string 9123 - $ref: "#/components/parameters/FactoryWorkspace" 9124 - $ref: "#/components/parameters/IdempotencyKey" 9125 responses: 9126 "201": 9127 description: The created resource. 9128 content: 9129 application/json: 9130 schema: 9131 type: object 9132 "400": 9133 $ref: "#/components/responses/Err400" 9134 description: VALIDATION_ERROR — request validation failed. 9135 "401": 9136 $ref: "#/components/responses/Err401" 9137 description: UNAUTHORIZED — missing/invalid credentials. 9138 "403": 9139 $ref: "#/components/responses/Err403" 9140 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9141 "404": 9142 $ref: "#/components/responses/Err404" 9143 description: NOT_FOUND — resource does not exist for this caller. 9144 "409": 9145 $ref: "#/components/responses/Err409" 9146 description: CONFLICT — duplicate or state conflict. 9147 "429": 9148 $ref: "#/components/responses/Err429" 9149 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9150 "500": 9151 $ref: "#/components/responses/Err500" 9152 description: INTERNAL_ERROR — unexpected server error. 9153 /workspaces/{workspaceId}/ai/conversations/{conversationId}/messages: 9154 post: 9155 operationId: PostWorkspacesByWorkspaceIdAiConversationsByConversationIdMessages 9156 tags: 9157 - AI 9158 summary: Send a message in a conversation (user-identity only) 9159 security: 9160 - bearerAuth: [] 9161 parameters: 9162 - name: workspaceId 9163 in: path 9164 required: true 9165 schema: 9166 type: string 9167 - name: conversationId 9168 in: path 9169 required: true 9170 schema: 9171 type: string 9172 - $ref: "#/components/parameters/FactoryWorkspace" 9173 - $ref: "#/components/parameters/IdempotencyKey" 9174 responses: 9175 "200": 9176 description: OK. 9177 content: 9178 application/json: 9179 schema: 9180 type: object 9181 "400": 9182 $ref: "#/components/responses/Err400" 9183 description: VALIDATION_ERROR — request validation failed. 9184 "401": 9185 $ref: "#/components/responses/Err401" 9186 description: UNAUTHORIZED — missing/invalid credentials. 9187 "403": 9188 $ref: "#/components/responses/Err403" 9189 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9190 "404": 9191 $ref: "#/components/responses/Err404" 9192 description: NOT_FOUND — resource does not exist for this caller. 9193 "429": 9194 $ref: "#/components/responses/Err429" 9195 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9196 "500": 9197 $ref: "#/components/responses/Err500" 9198 description: INTERNAL_ERROR — unexpected server error. 9199 /workspaces/{workspaceId}/ai/databases/extract: 9200 post: 9201 operationId: PostWorkspacesByWorkspaceIdAiDatabasesExtract 9202 tags: 9203 - AI 9204 summary: Create ai by workspaceId 9205 security: 9206 - bearerAuth: [] 9207 parameters: 9208 - name: workspaceId 9209 in: path 9210 required: true 9211 schema: 9212 type: string 9213 - $ref: "#/components/parameters/FactoryWorkspace" 9214 - $ref: "#/components/parameters/IdempotencyKey" 9215 responses: 9216 "200": 9217 description: OK. 9218 content: 9219 application/json: 9220 schema: 9221 type: object 9222 "400": 9223 $ref: "#/components/responses/Err400" 9224 description: VALIDATION_ERROR — request validation failed. 9225 "401": 9226 $ref: "#/components/responses/Err401" 9227 description: UNAUTHORIZED — missing/invalid credentials. 9228 "403": 9229 $ref: "#/components/responses/Err403" 9230 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9231 "404": 9232 $ref: "#/components/responses/Err404" 9233 description: NOT_FOUND — resource does not exist for this caller. 9234 "429": 9235 $ref: "#/components/responses/Err429" 9236 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9237 "500": 9238 $ref: "#/components/responses/Err500" 9239 description: INTERNAL_ERROR — unexpected server error. 9240 /workspaces/{workspaceId}/ai/databases/extract/preview: 9241 post: 9242 operationId: PostWorkspacesByWorkspaceIdAiDatabasesExtractPreview 9243 tags: 9244 - AI 9245 summary: Create ai by workspaceId 9246 security: 9247 - bearerAuth: [] 9248 parameters: 9249 - name: workspaceId 9250 in: path 9251 required: true 9252 schema: 9253 type: string 9254 - $ref: "#/components/parameters/FactoryWorkspace" 9255 - $ref: "#/components/parameters/IdempotencyKey" 9256 responses: 9257 "200": 9258 description: OK. 9259 content: 9260 application/json: 9261 schema: 9262 type: object 9263 "400": 9264 $ref: "#/components/responses/Err400" 9265 description: VALIDATION_ERROR — request validation failed. 9266 "401": 9267 $ref: "#/components/responses/Err401" 9268 description: UNAUTHORIZED — missing/invalid credentials. 9269 "403": 9270 $ref: "#/components/responses/Err403" 9271 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9272 "404": 9273 $ref: "#/components/responses/Err404" 9274 description: NOT_FOUND — resource does not exist for this caller. 9275 "429": 9276 $ref: "#/components/responses/Err429" 9277 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9278 "500": 9279 $ref: "#/components/responses/Err500" 9280 description: INTERNAL_ERROR — unexpected server error. 9281 /workspaces/{workspaceId}/ai/databases/formulas: 9282 post: 9283 operationId: PostWorkspacesByWorkspaceIdAiDatabasesFormulas 9284 tags: 9285 - AI 9286 summary: Create ai by workspaceId 9287 security: 9288 - bearerAuth: [] 9289 parameters: 9290 - name: workspaceId 9291 in: path 9292 required: true 9293 schema: 9294 type: string 9295 - $ref: "#/components/parameters/FactoryWorkspace" 9296 - $ref: "#/components/parameters/IdempotencyKey" 9297 responses: 9298 "200": 9299 description: OK. 9300 content: 9301 application/json: 9302 schema: 9303 type: object 9304 "400": 9305 $ref: "#/components/responses/Err400" 9306 description: VALIDATION_ERROR — request validation failed. 9307 "401": 9308 $ref: "#/components/responses/Err401" 9309 description: UNAUTHORIZED — missing/invalid credentials. 9310 "403": 9311 $ref: "#/components/responses/Err403" 9312 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9313 "404": 9314 $ref: "#/components/responses/Err404" 9315 description: NOT_FOUND — resource does not exist for this caller. 9316 "429": 9317 $ref: "#/components/responses/Err429" 9318 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9319 "500": 9320 $ref: "#/components/responses/Err500" 9321 description: INTERNAL_ERROR — unexpected server error. 9322 /workspaces/{workspaceId}/ai/databases/generate: 9323 post: 9324 operationId: PostWorkspacesByWorkspaceIdAiDatabasesGenerate 9325 tags: 9326 - AI 9327 summary: Create ai by workspaceId 9328 security: 9329 - bearerAuth: [] 9330 parameters: 9331 - name: workspaceId 9332 in: path 9333 required: true 9334 schema: 9335 type: string 9336 - $ref: "#/components/parameters/FactoryWorkspace" 9337 - $ref: "#/components/parameters/IdempotencyKey" 9338 responses: 9339 "200": 9340 description: OK. 9341 content: 9342 application/json: 9343 schema: 9344 type: object 9345 "400": 9346 $ref: "#/components/responses/Err400" 9347 description: VALIDATION_ERROR — request validation failed. 9348 "401": 9349 $ref: "#/components/responses/Err401" 9350 description: UNAUTHORIZED — missing/invalid credentials. 9351 "403": 9352 $ref: "#/components/responses/Err403" 9353 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9354 "404": 9355 $ref: "#/components/responses/Err404" 9356 description: NOT_FOUND — resource does not exist for this caller. 9357 "429": 9358 $ref: "#/components/responses/Err429" 9359 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9360 "500": 9361 $ref: "#/components/responses/Err500" 9362 description: INTERNAL_ERROR — unexpected server error. 9363 /workspaces/{workspaceId}/ai/generate: 9364 post: 9365 operationId: PostWorkspacesByWorkspaceIdAiGenerate 9366 tags: 9367 - AI 9368 summary: Create ai by workspaceId 9369 security: 9370 - bearerAuth: [] 9371 parameters: 9372 - name: workspaceId 9373 in: path 9374 required: true 9375 schema: 9376 type: string 9377 - $ref: "#/components/parameters/FactoryWorkspace" 9378 - $ref: "#/components/parameters/IdempotencyKey" 9379 responses: 9380 "200": 9381 description: OK. 9382 content: 9383 application/json: 9384 schema: 9385 type: object 9386 "400": 9387 $ref: "#/components/responses/Err400" 9388 description: VALIDATION_ERROR — request validation failed. 9389 "401": 9390 $ref: "#/components/responses/Err401" 9391 description: UNAUTHORIZED — missing/invalid credentials. 9392 "403": 9393 $ref: "#/components/responses/Err403" 9394 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9395 "404": 9396 $ref: "#/components/responses/Err404" 9397 description: NOT_FOUND — resource does not exist for this caller. 9398 "429": 9399 $ref: "#/components/responses/Err429" 9400 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9401 "500": 9402 $ref: "#/components/responses/Err500" 9403 description: INTERNAL_ERROR — unexpected server error. 9404 /workspaces/{workspaceId}/ai/ping: 9405 post: 9406 operationId: PostWorkspacesByWorkspaceIdAiPing 9407 tags: 9408 - AI 9409 summary: AI availability ping 9410 security: 9411 - bearerAuth: [] 9412 parameters: 9413 - name: workspaceId 9414 in: path 9415 required: true 9416 schema: 9417 type: string 9418 - $ref: "#/components/parameters/FactoryWorkspace" 9419 - $ref: "#/components/parameters/IdempotencyKey" 9420 responses: 9421 "200": 9422 description: OK. 9423 content: 9424 application/json: 9425 schema: 9426 type: object 9427 "400": 9428 $ref: "#/components/responses/Err400" 9429 description: VALIDATION_ERROR — request validation failed. 9430 "401": 9431 $ref: "#/components/responses/Err401" 9432 description: UNAUTHORIZED — missing/invalid credentials. 9433 "403": 9434 $ref: "#/components/responses/Err403" 9435 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9436 "404": 9437 $ref: "#/components/responses/Err404" 9438 description: NOT_FOUND — resource does not exist for this caller. 9439 "429": 9440 $ref: "#/components/responses/Err429" 9441 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9442 "500": 9443 $ref: "#/components/responses/Err500" 9444 description: INTERNAL_ERROR — unexpected server error. 9445 /workspaces/{workspaceId}/ai/search: 9446 post: 9447 operationId: PostWorkspacesByWorkspaceIdAiSearch 9448 tags: 9449 - AI 9450 summary: Create ai by workspaceId 9451 security: 9452 - bearerAuth: [] 9453 parameters: 9454 - name: workspaceId 9455 in: path 9456 required: true 9457 schema: 9458 type: string 9459 - $ref: "#/components/parameters/FactoryWorkspace" 9460 - $ref: "#/components/parameters/IdempotencyKey" 9461 responses: 9462 "200": 9463 description: OK. 9464 content: 9465 application/json: 9466 schema: 9467 type: object 9468 "400": 9469 $ref: "#/components/responses/Err400" 9470 description: VALIDATION_ERROR — request validation failed. 9471 "401": 9472 $ref: "#/components/responses/Err401" 9473 description: UNAUTHORIZED — missing/invalid credentials. 9474 "403": 9475 $ref: "#/components/responses/Err403" 9476 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9477 "404": 9478 $ref: "#/components/responses/Err404" 9479 description: NOT_FOUND — resource does not exist for this caller. 9480 "429": 9481 $ref: "#/components/responses/Err429" 9482 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9483 "500": 9484 $ref: "#/components/responses/Err500" 9485 description: INTERNAL_ERROR — unexpected server error. 9486 /workspaces/{workspaceId}/ai/writing: 9487 post: 9488 operationId: PostWorkspacesByWorkspaceIdAiWriting 9489 tags: 9490 - AI 9491 summary: Create ai by workspaceId 9492 security: 9493 - bearerAuth: [] 9494 parameters: 9495 - name: workspaceId 9496 in: path 9497 required: true 9498 schema: 9499 type: string 9500 - $ref: "#/components/parameters/FactoryWorkspace" 9501 - $ref: "#/components/parameters/IdempotencyKey" 9502 responses: 9503 "200": 9504 description: OK. 9505 content: 9506 application/json: 9507 schema: 9508 type: object 9509 "400": 9510 $ref: "#/components/responses/Err400" 9511 description: VALIDATION_ERROR — request validation failed. 9512 "401": 9513 $ref: "#/components/responses/Err401" 9514 description: UNAUTHORIZED — missing/invalid credentials. 9515 "403": 9516 $ref: "#/components/responses/Err403" 9517 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9518 "404": 9519 $ref: "#/components/responses/Err404" 9520 description: NOT_FOUND — resource does not exist for this caller. 9521 "429": 9522 $ref: "#/components/responses/Err429" 9523 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9524 "500": 9525 $ref: "#/components/responses/Err500" 9526 description: INTERNAL_ERROR — unexpected server error. 9527 /workspaces/{workspaceId}/ai/writing/apply: 9528 post: 9529 operationId: PostWorkspacesByWorkspaceIdAiWritingApply 9530 tags: 9531 - AI 9532 summary: Create ai by workspaceId 9533 security: 9534 - bearerAuth: [] 9535 parameters: 9536 - name: workspaceId 9537 in: path 9538 required: true 9539 schema: 9540 type: string 9541 - $ref: "#/components/parameters/FactoryWorkspace" 9542 - $ref: "#/components/parameters/IdempotencyKey" 9543 responses: 9544 "200": 9545 description: OK. 9546 content: 9547 application/json: 9548 schema: 9549 type: object 9550 "400": 9551 $ref: "#/components/responses/Err400" 9552 description: VALIDATION_ERROR — request validation failed. 9553 "401": 9554 $ref: "#/components/responses/Err401" 9555 description: UNAUTHORIZED — missing/invalid credentials. 9556 "403": 9557 $ref: "#/components/responses/Err403" 9558 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9559 "404": 9560 $ref: "#/components/responses/Err404" 9561 description: NOT_FOUND — resource does not exist for this caller. 9562 "429": 9563 $ref: "#/components/responses/Err429" 9564 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9565 "500": 9566 $ref: "#/components/responses/Err500" 9567 description: INTERNAL_ERROR — unexpected server error. 9568 /workspaces/{workspaceId}/api-keys: 9569 post: 9570 operationId: PostWorkspacesByWorkspaceIdApiKeys 9571 tags: 9572 - API Keys 9573 summary: Create an API key 9574 security: 9575 - bearerAuth: [] 9576 parameters: 9577 - name: workspaceId 9578 in: path 9579 required: true 9580 schema: 9581 type: string 9582 - $ref: "#/components/parameters/FactoryWorkspace" 9583 - $ref: "#/components/parameters/IdempotencyKey" 9584 responses: 9585 "201": 9586 description: The created resource. 9587 content: 9588 application/json: 9589 schema: 9590 type: object 9591 "400": 9592 $ref: "#/components/responses/Err400" 9593 description: VALIDATION_ERROR — request validation failed. 9594 "401": 9595 $ref: "#/components/responses/Err401" 9596 description: UNAUTHORIZED — missing/invalid credentials. 9597 "403": 9598 $ref: "#/components/responses/Err403" 9599 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9600 "404": 9601 $ref: "#/components/responses/Err404" 9602 description: NOT_FOUND — resource does not exist for this caller. 9603 "409": 9604 $ref: "#/components/responses/Err409" 9605 description: CONFLICT — duplicate or state conflict. 9606 "429": 9607 $ref: "#/components/responses/Err429" 9608 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9609 "500": 9610 $ref: "#/components/responses/Err500" 9611 description: INTERNAL_ERROR — unexpected server error. 9612 get: 9613 operationId: GetWorkspacesByWorkspaceIdApiKeys 9614 tags: 9615 - API Keys 9616 summary: List the workspace's API keys 9617 security: 9618 - bearerAuth: [] 9619 parameters: 9620 - name: workspaceId 9621 in: path 9622 required: true 9623 schema: 9624 type: string 9625 - $ref: "#/components/parameters/FactoryWorkspace" 9626 responses: 9627 "200": 9628 description: OK. 9629 content: 9630 application/json: 9631 schema: 9632 type: object 9633 "401": 9634 $ref: "#/components/responses/Err401" 9635 description: UNAUTHORIZED — missing/invalid credentials. 9636 "403": 9637 $ref: "#/components/responses/Err403" 9638 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9639 "404": 9640 $ref: "#/components/responses/Err404" 9641 description: NOT_FOUND — resource does not exist for this caller. 9642 "429": 9643 $ref: "#/components/responses/Err429" 9644 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9645 "500": 9646 $ref: "#/components/responses/Err500" 9647 description: INTERNAL_ERROR — unexpected server error. 9648 /workspaces/{workspaceId}/api-keys/{id}: 9649 patch: 9650 operationId: PatchWorkspacesByWorkspaceIdApiKeysById 9651 tags: 9652 - API Keys 9653 summary: Update an API key (scope / rate limit / expiry / name) 9654 security: 9655 - bearerAuth: [] 9656 parameters: 9657 - name: workspaceId 9658 in: path 9659 required: true 9660 schema: 9661 type: string 9662 - name: id 9663 in: path 9664 required: true 9665 schema: 9666 type: string 9667 - $ref: "#/components/parameters/FactoryWorkspace" 9668 - $ref: "#/components/parameters/IdempotencyKey" 9669 responses: 9670 "200": 9671 description: OK. 9672 content: 9673 application/json: 9674 schema: 9675 type: object 9676 "400": 9677 $ref: "#/components/responses/Err400" 9678 description: VALIDATION_ERROR — request validation failed. 9679 "401": 9680 $ref: "#/components/responses/Err401" 9681 description: UNAUTHORIZED — missing/invalid credentials. 9682 "403": 9683 $ref: "#/components/responses/Err403" 9684 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9685 "404": 9686 $ref: "#/components/responses/Err404" 9687 description: NOT_FOUND — resource does not exist for this caller. 9688 "409": 9689 $ref: "#/components/responses/Err409" 9690 description: CONFLICT — duplicate or state conflict. 9691 "429": 9692 $ref: "#/components/responses/Err429" 9693 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9694 "500": 9695 $ref: "#/components/responses/Err500" 9696 description: INTERNAL_ERROR — unexpected server error. 9697 delete: 9698 operationId: DeleteWorkspacesByWorkspaceIdApiKeysById 9699 tags: 9700 - API Keys 9701 summary: Revoke an API key 9702 security: 9703 - bearerAuth: [] 9704 parameters: 9705 - name: workspaceId 9706 in: path 9707 required: true 9708 schema: 9709 type: string 9710 - name: id 9711 in: path 9712 required: true 9713 schema: 9714 type: string 9715 - $ref: "#/components/parameters/FactoryWorkspace" 9716 - $ref: "#/components/parameters/IdempotencyKey" 9717 responses: 9718 "200": 9719 description: OK. 9720 content: 9721 application/json: 9722 schema: 9723 type: object 9724 "400": 9725 $ref: "#/components/responses/Err400" 9726 description: VALIDATION_ERROR — request validation failed. 9727 "401": 9728 $ref: "#/components/responses/Err401" 9729 description: UNAUTHORIZED — missing/invalid credentials. 9730 "403": 9731 $ref: "#/components/responses/Err403" 9732 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9733 "404": 9734 $ref: "#/components/responses/Err404" 9735 description: NOT_FOUND — resource does not exist for this caller. 9736 "429": 9737 $ref: "#/components/responses/Err429" 9738 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9739 "500": 9740 $ref: "#/components/responses/Err500" 9741 description: INTERNAL_ERROR — unexpected server error. 9742 /workspaces/{workspaceId}/audit: 9743 get: 9744 operationId: GetWorkspacesByWorkspaceIdAudit 9745 tags: 9746 - Audit 9747 summary: Get audit by workspaceId 9748 security: 9749 - bearerAuth: [] 9750 parameters: 9751 - name: workspaceId 9752 in: path 9753 required: true 9754 schema: 9755 type: string 9756 - $ref: "#/components/parameters/FactoryWorkspace" 9757 responses: 9758 "200": 9759 description: OK. 9760 content: 9761 application/json: 9762 schema: 9763 type: object 9764 "401": 9765 $ref: "#/components/responses/Err401" 9766 description: UNAUTHORIZED — missing/invalid credentials. 9767 "403": 9768 $ref: "#/components/responses/Err403" 9769 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9770 "404": 9771 $ref: "#/components/responses/Err404" 9772 description: NOT_FOUND — resource does not exist for this caller. 9773 "429": 9774 $ref: "#/components/responses/Err429" 9775 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9776 "500": 9777 $ref: "#/components/responses/Err500" 9778 description: INTERNAL_ERROR — unexpected server error. 9779 /workspaces/{workspaceId}/automations: 9780 get: 9781 operationId: GetWorkspacesByWorkspaceIdAutomations 9782 tags: 9783 - Automations 9784 summary: Get automations by workspaceId 9785 security: 9786 - bearerAuth: [] 9787 parameters: 9788 - name: workspaceId 9789 in: path 9790 required: true 9791 schema: 9792 type: string 9793 - $ref: "#/components/parameters/FactoryWorkspace" 9794 responses: 9795 "200": 9796 description: OK. 9797 content: 9798 application/json: 9799 schema: 9800 type: object 9801 "401": 9802 $ref: "#/components/responses/Err401" 9803 description: UNAUTHORIZED — missing/invalid credentials. 9804 "403": 9805 $ref: "#/components/responses/Err403" 9806 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9807 "404": 9808 $ref: "#/components/responses/Err404" 9809 description: NOT_FOUND — resource does not exist for this caller. 9810 "429": 9811 $ref: "#/components/responses/Err429" 9812 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9813 "500": 9814 $ref: "#/components/responses/Err500" 9815 description: INTERNAL_ERROR — unexpected server error. 9816 post: 9817 operationId: PostWorkspacesByWorkspaceIdAutomations 9818 tags: 9819 - Automations 9820 summary: Create automations by workspaceId 9821 security: 9822 - bearerAuth: [] 9823 parameters: 9824 - name: workspaceId 9825 in: path 9826 required: true 9827 schema: 9828 type: string 9829 - $ref: "#/components/parameters/FactoryWorkspace" 9830 - $ref: "#/components/parameters/IdempotencyKey" 9831 responses: 9832 "201": 9833 description: The created resource. 9834 content: 9835 application/json: 9836 schema: 9837 type: object 9838 "400": 9839 $ref: "#/components/responses/Err400" 9840 description: VALIDATION_ERROR — request validation failed. 9841 "401": 9842 $ref: "#/components/responses/Err401" 9843 description: UNAUTHORIZED — missing/invalid credentials. 9844 "403": 9845 $ref: "#/components/responses/Err403" 9846 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9847 "404": 9848 $ref: "#/components/responses/Err404" 9849 description: NOT_FOUND — resource does not exist for this caller. 9850 "409": 9851 $ref: "#/components/responses/Err409" 9852 description: CONFLICT — duplicate or state conflict. 9853 "429": 9854 $ref: "#/components/responses/Err429" 9855 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9856 "500": 9857 $ref: "#/components/responses/Err500" 9858 description: INTERNAL_ERROR — unexpected server error. 9859 /workspaces/{workspaceId}/embeds/preview: 9860 get: 9861 operationId: GetWorkspacesByWorkspaceIdEmbedsPreview 9862 tags: 9863 - Embeds 9864 summary: Get embeds by workspaceId 9865 security: 9866 - bearerAuth: [] 9867 parameters: 9868 - name: workspaceId 9869 in: path 9870 required: true 9871 schema: 9872 type: string 9873 - $ref: "#/components/parameters/FactoryWorkspace" 9874 responses: 9875 "200": 9876 description: OK. 9877 content: 9878 application/json: 9879 schema: 9880 type: object 9881 "401": 9882 $ref: "#/components/responses/Err401" 9883 description: UNAUTHORIZED — missing/invalid credentials. 9884 "403": 9885 $ref: "#/components/responses/Err403" 9886 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9887 "404": 9888 $ref: "#/components/responses/Err404" 9889 description: NOT_FOUND — resource does not exist for this caller. 9890 "429": 9891 $ref: "#/components/responses/Err429" 9892 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9893 "500": 9894 $ref: "#/components/responses/Err500" 9895 description: INTERNAL_ERROR — unexpected server error. 9896 /workspaces/{workspaceId}/integrations: 9897 get: 9898 operationId: GetWorkspacesByWorkspaceIdIntegrations 9899 tags: 9900 - Integrations 9901 summary: Get integrations by workspaceId 9902 security: 9903 - bearerAuth: [] 9904 parameters: 9905 - name: workspaceId 9906 in: path 9907 required: true 9908 schema: 9909 type: string 9910 - $ref: "#/components/parameters/FactoryWorkspace" 9911 responses: 9912 "200": 9913 description: OK. 9914 content: 9915 application/json: 9916 schema: 9917 type: object 9918 "401": 9919 $ref: "#/components/responses/Err401" 9920 description: UNAUTHORIZED — missing/invalid credentials. 9921 "403": 9922 $ref: "#/components/responses/Err403" 9923 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9924 "404": 9925 $ref: "#/components/responses/Err404" 9926 description: NOT_FOUND — resource does not exist for this caller. 9927 "429": 9928 $ref: "#/components/responses/Err429" 9929 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9930 "500": 9931 $ref: "#/components/responses/Err500" 9932 description: INTERNAL_ERROR — unexpected server error. 9933 post: 9934 operationId: PostWorkspacesByWorkspaceIdIntegrations 9935 tags: 9936 - Integrations 9937 summary: Create integrations by workspaceId 9938 security: 9939 - bearerAuth: [] 9940 parameters: 9941 - name: workspaceId 9942 in: path 9943 required: true 9944 schema: 9945 type: string 9946 - $ref: "#/components/parameters/FactoryWorkspace" 9947 - $ref: "#/components/parameters/IdempotencyKey" 9948 responses: 9949 "201": 9950 description: The created resource. 9951 content: 9952 application/json: 9953 schema: 9954 type: object 9955 "400": 9956 $ref: "#/components/responses/Err400" 9957 description: VALIDATION_ERROR — request validation failed. 9958 "401": 9959 $ref: "#/components/responses/Err401" 9960 description: UNAUTHORIZED — missing/invalid credentials. 9961 "403": 9962 $ref: "#/components/responses/Err403" 9963 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 9964 "404": 9965 $ref: "#/components/responses/Err404" 9966 description: NOT_FOUND — resource does not exist for this caller. 9967 "409": 9968 $ref: "#/components/responses/Err409" 9969 description: CONFLICT — duplicate or state conflict. 9970 "429": 9971 $ref: "#/components/responses/Err429" 9972 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 9973 "500": 9974 $ref: "#/components/responses/Err500" 9975 description: INTERNAL_ERROR — unexpected server error. 9976 /workspaces/{workspaceId}/integrations/{id}: 9977 patch: 9978 operationId: PatchWorkspacesByWorkspaceIdIntegrationsById 9979 tags: 9980 - Integrations 9981 summary: Update integrations by workspaceId + id 9982 security: 9983 - bearerAuth: [] 9984 parameters: 9985 - name: workspaceId 9986 in: path 9987 required: true 9988 schema: 9989 type: string 9990 - name: id 9991 in: path 9992 required: true 9993 schema: 9994 type: string 9995 - $ref: "#/components/parameters/FactoryWorkspace" 9996 - $ref: "#/components/parameters/IdempotencyKey" 9997 responses: 9998 "200": 9999 description: OK. 10000 content: 10001 application/json: 10002 schema: 10003 type: object 10004 "400": 10005 $ref: "#/components/responses/Err400" 10006 description: VALIDATION_ERROR — request validation failed. 10007 "401": 10008 $ref: "#/components/responses/Err401" 10009 description: UNAUTHORIZED — missing/invalid credentials. 10010 "403": 10011 $ref: "#/components/responses/Err403" 10012 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10013 "404": 10014 $ref: "#/components/responses/Err404" 10015 description: NOT_FOUND — resource does not exist for this caller. 10016 "409": 10017 $ref: "#/components/responses/Err409" 10018 description: CONFLICT — duplicate or state conflict. 10019 "429": 10020 $ref: "#/components/responses/Err429" 10021 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10022 "500": 10023 $ref: "#/components/responses/Err500" 10024 description: INTERNAL_ERROR — unexpected server error. 10025 delete: 10026 operationId: DeleteWorkspacesByWorkspaceIdIntegrationsById 10027 tags: 10028 - Integrations 10029 summary: Delete integrations by workspaceId + id 10030 security: 10031 - bearerAuth: [] 10032 parameters: 10033 - name: workspaceId 10034 in: path 10035 required: true 10036 schema: 10037 type: string 10038 - name: id 10039 in: path 10040 required: true 10041 schema: 10042 type: string 10043 - $ref: "#/components/parameters/FactoryWorkspace" 10044 - $ref: "#/components/parameters/IdempotencyKey" 10045 responses: 10046 "200": 10047 description: OK. 10048 content: 10049 application/json: 10050 schema: 10051 type: object 10052 "400": 10053 $ref: "#/components/responses/Err400" 10054 description: VALIDATION_ERROR — request validation failed. 10055 "401": 10056 $ref: "#/components/responses/Err401" 10057 description: UNAUTHORIZED — missing/invalid credentials. 10058 "403": 10059 $ref: "#/components/responses/Err403" 10060 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10061 "404": 10062 $ref: "#/components/responses/Err404" 10063 description: NOT_FOUND — resource does not exist for this caller. 10064 "429": 10065 $ref: "#/components/responses/Err429" 10066 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10067 "500": 10068 $ref: "#/components/responses/Err500" 10069 description: INTERNAL_ERROR — unexpected server error. 10070 /workspaces/{workspaceId}/oauth/apps: 10071 post: 10072 operationId: PostWorkspacesByWorkspaceIdOauthApps 10073 tags: 10074 - OAuth2 10075 summary: Create oauth2 by workspaceId 10076 security: 10077 - bearerAuth: [] 10078 parameters: 10079 - name: workspaceId 10080 in: path 10081 required: true 10082 schema: 10083 type: string 10084 - $ref: "#/components/parameters/FactoryWorkspace" 10085 - $ref: "#/components/parameters/IdempotencyKey" 10086 responses: 10087 "200": 10088 description: OK. 10089 content: 10090 application/json: 10091 schema: 10092 type: object 10093 "400": 10094 $ref: "#/components/responses/Err400" 10095 description: VALIDATION_ERROR — request validation failed. 10096 "401": 10097 $ref: "#/components/responses/Err401" 10098 description: UNAUTHORIZED — missing/invalid credentials. 10099 "403": 10100 $ref: "#/components/responses/Err403" 10101 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10102 "404": 10103 $ref: "#/components/responses/Err404" 10104 description: NOT_FOUND — resource does not exist for this caller. 10105 "429": 10106 $ref: "#/components/responses/Err429" 10107 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10108 "500": 10109 $ref: "#/components/responses/Err500" 10110 description: INTERNAL_ERROR — unexpected server error. 10111 get: 10112 operationId: GetWorkspacesByWorkspaceIdOauthApps 10113 tags: 10114 - OAuth2 10115 summary: Get oauth2 by workspaceId 10116 security: 10117 - bearerAuth: [] 10118 parameters: 10119 - name: workspaceId 10120 in: path 10121 required: true 10122 schema: 10123 type: string 10124 - $ref: "#/components/parameters/FactoryWorkspace" 10125 responses: 10126 "200": 10127 description: OK. 10128 content: 10129 application/json: 10130 schema: 10131 type: object 10132 "401": 10133 $ref: "#/components/responses/Err401" 10134 description: UNAUTHORIZED — missing/invalid credentials. 10135 "403": 10136 $ref: "#/components/responses/Err403" 10137 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10138 "404": 10139 $ref: "#/components/responses/Err404" 10140 description: NOT_FOUND — resource does not exist for this caller. 10141 "429": 10142 $ref: "#/components/responses/Err429" 10143 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10144 "500": 10145 $ref: "#/components/responses/Err500" 10146 description: INTERNAL_ERROR — unexpected server error. 10147 /workspaces/{workspaceId}/oauth/apps/{clientId}: 10148 patch: 10149 operationId: PatchWorkspacesByWorkspaceIdOauthAppsByClientId 10150 tags: 10151 - OAuth2 10152 summary: Update oauth2 by workspaceId + clientId 10153 security: 10154 - bearerAuth: [] 10155 parameters: 10156 - name: workspaceId 10157 in: path 10158 required: true 10159 schema: 10160 type: string 10161 - name: clientId 10162 in: path 10163 required: true 10164 schema: 10165 type: string 10166 - $ref: "#/components/parameters/FactoryWorkspace" 10167 - $ref: "#/components/parameters/IdempotencyKey" 10168 responses: 10169 "200": 10170 description: OK. 10171 content: 10172 application/json: 10173 schema: 10174 type: object 10175 "400": 10176 $ref: "#/components/responses/Err400" 10177 description: VALIDATION_ERROR — request validation failed. 10178 "401": 10179 $ref: "#/components/responses/Err401" 10180 description: UNAUTHORIZED — missing/invalid credentials. 10181 "403": 10182 $ref: "#/components/responses/Err403" 10183 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10184 "404": 10185 $ref: "#/components/responses/Err404" 10186 description: NOT_FOUND — resource does not exist for this caller. 10187 "409": 10188 $ref: "#/components/responses/Err409" 10189 description: CONFLICT — duplicate or state conflict. 10190 "429": 10191 $ref: "#/components/responses/Err429" 10192 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10193 "500": 10194 $ref: "#/components/responses/Err500" 10195 description: INTERNAL_ERROR — unexpected server error. 10196 delete: 10197 operationId: DeleteWorkspacesByWorkspaceIdOauthAppsByClientId 10198 tags: 10199 - OAuth2 10200 summary: Delete oauth2 by workspaceId + clientId 10201 security: 10202 - bearerAuth: [] 10203 parameters: 10204 - name: workspaceId 10205 in: path 10206 required: true 10207 schema: 10208 type: string 10209 - name: clientId 10210 in: path 10211 required: true 10212 schema: 10213 type: string 10214 - $ref: "#/components/parameters/FactoryWorkspace" 10215 - $ref: "#/components/parameters/IdempotencyKey" 10216 responses: 10217 "200": 10218 description: OK. 10219 content: 10220 application/json: 10221 schema: 10222 type: object 10223 "400": 10224 $ref: "#/components/responses/Err400" 10225 description: VALIDATION_ERROR — request validation failed. 10226 "401": 10227 $ref: "#/components/responses/Err401" 10228 description: UNAUTHORIZED — missing/invalid credentials. 10229 "403": 10230 $ref: "#/components/responses/Err403" 10231 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10232 "404": 10233 $ref: "#/components/responses/Err404" 10234 description: NOT_FOUND — resource does not exist for this caller. 10235 "429": 10236 $ref: "#/components/responses/Err429" 10237 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10238 "500": 10239 $ref: "#/components/responses/Err500" 10240 description: INTERNAL_ERROR — unexpected server error. 10241 /workspaces/{workspaceId}/pages: 10242 get: 10243 operationId: GetWorkspacesByWorkspaceIdPages 10244 tags: 10245 - Pages 10246 summary: Get pages by workspaceId 10247 security: 10248 - bearerAuth: [] 10249 parameters: 10250 - name: workspaceId 10251 in: path 10252 required: true 10253 schema: 10254 type: string 10255 - $ref: "#/components/parameters/FactoryWorkspace" 10256 responses: 10257 "200": 10258 description: OK. 10259 content: 10260 application/json: 10261 schema: 10262 type: object 10263 "401": 10264 $ref: "#/components/responses/Err401" 10265 description: UNAUTHORIZED — missing/invalid credentials. 10266 "403": 10267 $ref: "#/components/responses/Err403" 10268 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10269 "404": 10270 $ref: "#/components/responses/Err404" 10271 description: NOT_FOUND — resource does not exist for this caller. 10272 "429": 10273 $ref: "#/components/responses/Err429" 10274 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10275 "500": 10276 $ref: "#/components/responses/Err500" 10277 description: INTERNAL_ERROR — unexpected server error. 10278 post: 10279 operationId: PostWorkspacesByWorkspaceIdPages 10280 tags: 10281 - Pages 10282 summary: Create pages by workspaceId 10283 security: 10284 - bearerAuth: [] 10285 parameters: 10286 - name: workspaceId 10287 in: path 10288 required: true 10289 schema: 10290 type: string 10291 - $ref: "#/components/parameters/FactoryWorkspace" 10292 - $ref: "#/components/parameters/IdempotencyKey" 10293 responses: 10294 "201": 10295 description: The created resource. 10296 content: 10297 application/json: 10298 schema: 10299 type: object 10300 "400": 10301 $ref: "#/components/responses/Err400" 10302 description: VALIDATION_ERROR — request validation failed. 10303 "401": 10304 $ref: "#/components/responses/Err401" 10305 description: UNAUTHORIZED — missing/invalid credentials. 10306 "403": 10307 $ref: "#/components/responses/Err403" 10308 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10309 "404": 10310 $ref: "#/components/responses/Err404" 10311 description: NOT_FOUND — resource does not exist for this caller. 10312 "409": 10313 $ref: "#/components/responses/Err409" 10314 description: CONFLICT — duplicate or state conflict. 10315 "429": 10316 $ref: "#/components/responses/Err429" 10317 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10318 "500": 10319 $ref: "#/components/responses/Err500" 10320 description: INTERNAL_ERROR — unexpected server error. 10321 /workspaces/{workspaceId}/policy/effective: 10322 get: 10323 operationId: GetWorkspacesByWorkspaceIdPolicyEffective 10324 tags: 10325 - Policy 10326 summary: Get policy by workspaceId 10327 security: 10328 - bearerAuth: [] 10329 parameters: 10330 - name: workspaceId 10331 in: path 10332 required: true 10333 schema: 10334 type: string 10335 - $ref: "#/components/parameters/FactoryWorkspace" 10336 responses: 10337 "200": 10338 description: OK. 10339 content: 10340 application/json: 10341 schema: 10342 type: object 10343 "401": 10344 $ref: "#/components/responses/Err401" 10345 description: UNAUTHORIZED — missing/invalid credentials. 10346 "403": 10347 $ref: "#/components/responses/Err403" 10348 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10349 "404": 10350 $ref: "#/components/responses/Err404" 10351 description: NOT_FOUND — resource does not exist for this caller. 10352 "429": 10353 $ref: "#/components/responses/Err429" 10354 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10355 "500": 10356 $ref: "#/components/responses/Err500" 10357 description: INTERNAL_ERROR — unexpected server error. 10358 /workspaces/{workspaceId}/tasks: 10359 get: 10360 operationId: GetWorkspacesByWorkspaceIdTasks 10361 tags: 10362 - Tasks 10363 summary: Get tasks by workspaceId 10364 security: 10365 - bearerAuth: [] 10366 parameters: 10367 - name: workspaceId 10368 in: path 10369 required: true 10370 schema: 10371 type: string 10372 - $ref: "#/components/parameters/FactoryWorkspace" 10373 responses: 10374 "200": 10375 description: OK. 10376 content: 10377 application/json: 10378 schema: 10379 type: object 10380 "401": 10381 $ref: "#/components/responses/Err401" 10382 description: UNAUTHORIZED — missing/invalid credentials. 10383 "403": 10384 $ref: "#/components/responses/Err403" 10385 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10386 "404": 10387 $ref: "#/components/responses/Err404" 10388 description: NOT_FOUND — resource does not exist for this caller. 10389 "429": 10390 $ref: "#/components/responses/Err429" 10391 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10392 "500": 10393 $ref: "#/components/responses/Err500" 10394 description: INTERNAL_ERROR — unexpected server error. 10395 post: 10396 operationId: PostWorkspacesByWorkspaceIdTasks 10397 tags: 10398 - Tasks 10399 summary: Create tasks by workspaceId 10400 security: 10401 - bearerAuth: [] 10402 parameters: 10403 - name: workspaceId 10404 in: path 10405 required: true 10406 schema: 10407 type: string 10408 - $ref: "#/components/parameters/FactoryWorkspace" 10409 - $ref: "#/components/parameters/IdempotencyKey" 10410 responses: 10411 "200": 10412 description: OK. 10413 content: 10414 application/json: 10415 schema: 10416 type: object 10417 "400": 10418 $ref: "#/components/responses/Err400" 10419 description: VALIDATION_ERROR — request validation failed. 10420 "401": 10421 $ref: "#/components/responses/Err401" 10422 description: UNAUTHORIZED — missing/invalid credentials. 10423 "403": 10424 $ref: "#/components/responses/Err403" 10425 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10426 "404": 10427 $ref: "#/components/responses/Err404" 10428 description: NOT_FOUND — resource does not exist for this caller. 10429 "429": 10430 $ref: "#/components/responses/Err429" 10431 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10432 "500": 10433 $ref: "#/components/responses/Err500" 10434 description: INTERNAL_ERROR — unexpected server error. 10435 /workspaces/{workspaceId}/tasks/{id}: 10436 get: 10437 operationId: GetWorkspacesByWorkspaceIdTasksById 10438 tags: 10439 - Tasks 10440 summary: Get tasks by workspaceId + id 10441 security: 10442 - bearerAuth: [] 10443 parameters: 10444 - name: workspaceId 10445 in: path 10446 required: true 10447 schema: 10448 type: string 10449 - name: id 10450 in: path 10451 required: true 10452 schema: 10453 type: string 10454 - $ref: "#/components/parameters/FactoryWorkspace" 10455 responses: 10456 "200": 10457 description: OK. 10458 content: 10459 application/json: 10460 schema: 10461 type: object 10462 "401": 10463 $ref: "#/components/responses/Err401" 10464 description: UNAUTHORIZED — missing/invalid credentials. 10465 "403": 10466 $ref: "#/components/responses/Err403" 10467 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10468 "404": 10469 $ref: "#/components/responses/Err404" 10470 description: NOT_FOUND — resource does not exist for this caller. 10471 "429": 10472 $ref: "#/components/responses/Err429" 10473 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10474 "500": 10475 $ref: "#/components/responses/Err500" 10476 description: INTERNAL_ERROR — unexpected server error. 10477 patch: 10478 operationId: PatchWorkspacesByWorkspaceIdTasksById 10479 tags: 10480 - Tasks 10481 summary: Update tasks by workspaceId + id 10482 security: 10483 - bearerAuth: [] 10484 parameters: 10485 - name: workspaceId 10486 in: path 10487 required: true 10488 schema: 10489 type: string 10490 - name: id 10491 in: path 10492 required: true 10493 schema: 10494 type: string 10495 - $ref: "#/components/parameters/FactoryWorkspace" 10496 - $ref: "#/components/parameters/IdempotencyKey" 10497 responses: 10498 "200": 10499 description: OK. 10500 content: 10501 application/json: 10502 schema: 10503 type: object 10504 "400": 10505 $ref: "#/components/responses/Err400" 10506 description: VALIDATION_ERROR — request validation failed. 10507 "401": 10508 $ref: "#/components/responses/Err401" 10509 description: UNAUTHORIZED — missing/invalid credentials. 10510 "403": 10511 $ref: "#/components/responses/Err403" 10512 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10513 "404": 10514 $ref: "#/components/responses/Err404" 10515 description: NOT_FOUND — resource does not exist for this caller. 10516 "409": 10517 $ref: "#/components/responses/Err409" 10518 description: CONFLICT — duplicate or state conflict. 10519 "429": 10520 $ref: "#/components/responses/Err429" 10521 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10522 "500": 10523 $ref: "#/components/responses/Err500" 10524 description: INTERNAL_ERROR — unexpected server error. 10525 delete: 10526 operationId: DeleteWorkspacesByWorkspaceIdTasksById 10527 tags: 10528 - Tasks 10529 summary: Delete tasks by workspaceId + id 10530 security: 10531 - bearerAuth: [] 10532 parameters: 10533 - name: workspaceId 10534 in: path 10535 required: true 10536 schema: 10537 type: string 10538 - name: id 10539 in: path 10540 required: true 10541 schema: 10542 type: string 10543 - $ref: "#/components/parameters/FactoryWorkspace" 10544 - $ref: "#/components/parameters/IdempotencyKey" 10545 responses: 10546 "200": 10547 description: OK. 10548 content: 10549 application/json: 10550 schema: 10551 type: object 10552 "400": 10553 $ref: "#/components/responses/Err400" 10554 description: VALIDATION_ERROR — request validation failed. 10555 "401": 10556 $ref: "#/components/responses/Err401" 10557 description: UNAUTHORIZED — missing/invalid credentials. 10558 "403": 10559 $ref: "#/components/responses/Err403" 10560 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10561 "404": 10562 $ref: "#/components/responses/Err404" 10563 description: NOT_FOUND — resource does not exist for this caller. 10564 "429": 10565 $ref: "#/components/responses/Err429" 10566 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10567 "500": 10568 $ref: "#/components/responses/Err500" 10569 description: INTERNAL_ERROR — unexpected server error. 10570 /workspaces/{workspaceId}/teams: 10571 get: 10572 operationId: GetWorkspacesByWorkspaceIdTeams 10573 tags: 10574 - Teams 10575 summary: Get teams by workspaceId 10576 security: 10577 - bearerAuth: [] 10578 parameters: 10579 - name: workspaceId 10580 in: path 10581 required: true 10582 schema: 10583 type: string 10584 - $ref: "#/components/parameters/FactoryWorkspace" 10585 responses: 10586 "200": 10587 description: OK. 10588 content: 10589 application/json: 10590 schema: 10591 type: object 10592 "401": 10593 $ref: "#/components/responses/Err401" 10594 description: UNAUTHORIZED — missing/invalid credentials. 10595 "403": 10596 $ref: "#/components/responses/Err403" 10597 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10598 "404": 10599 $ref: "#/components/responses/Err404" 10600 description: NOT_FOUND — resource does not exist for this caller. 10601 "429": 10602 $ref: "#/components/responses/Err429" 10603 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10604 "500": 10605 $ref: "#/components/responses/Err500" 10606 description: INTERNAL_ERROR — unexpected server error. 10607 post: 10608 operationId: PostWorkspacesByWorkspaceIdTeams 10609 tags: 10610 - Teams 10611 summary: Create teams by workspaceId 10612 security: 10613 - bearerAuth: [] 10614 parameters: 10615 - name: workspaceId 10616 in: path 10617 required: true 10618 schema: 10619 type: string 10620 - $ref: "#/components/parameters/FactoryWorkspace" 10621 - $ref: "#/components/parameters/IdempotencyKey" 10622 responses: 10623 "201": 10624 description: The created resource. 10625 content: 10626 application/json: 10627 schema: 10628 type: object 10629 "400": 10630 $ref: "#/components/responses/Err400" 10631 description: VALIDATION_ERROR — request validation failed. 10632 "401": 10633 $ref: "#/components/responses/Err401" 10634 description: UNAUTHORIZED — missing/invalid credentials. 10635 "403": 10636 $ref: "#/components/responses/Err403" 10637 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10638 "404": 10639 $ref: "#/components/responses/Err404" 10640 description: NOT_FOUND — resource does not exist for this caller. 10641 "409": 10642 $ref: "#/components/responses/Err409" 10643 description: CONFLICT — duplicate or state conflict. 10644 "429": 10645 $ref: "#/components/responses/Err429" 10646 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10647 "500": 10648 $ref: "#/components/responses/Err500" 10649 description: INTERNAL_ERROR — unexpected server error. 10650 /workspaces/{workspaceId}/teams/{teamId}: 10651 get: 10652 operationId: GetWorkspacesByWorkspaceIdTeamsByTeamId 10653 tags: 10654 - Teams 10655 summary: Get teams by workspaceId + teamId 10656 security: 10657 - bearerAuth: [] 10658 parameters: 10659 - name: workspaceId 10660 in: path 10661 required: true 10662 schema: 10663 type: string 10664 - name: teamId 10665 in: path 10666 required: true 10667 schema: 10668 type: string 10669 - $ref: "#/components/parameters/FactoryWorkspace" 10670 responses: 10671 "200": 10672 description: OK. 10673 content: 10674 application/json: 10675 schema: 10676 type: object 10677 "401": 10678 $ref: "#/components/responses/Err401" 10679 description: UNAUTHORIZED — missing/invalid credentials. 10680 "403": 10681 $ref: "#/components/responses/Err403" 10682 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10683 "404": 10684 $ref: "#/components/responses/Err404" 10685 description: NOT_FOUND — resource does not exist for this caller. 10686 "429": 10687 $ref: "#/components/responses/Err429" 10688 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10689 "500": 10690 $ref: "#/components/responses/Err500" 10691 description: INTERNAL_ERROR — unexpected server error. 10692 patch: 10693 operationId: PatchWorkspacesByWorkspaceIdTeamsByTeamId 10694 tags: 10695 - Teams 10696 summary: Update teams by workspaceId + teamId 10697 security: 10698 - bearerAuth: [] 10699 parameters: 10700 - name: workspaceId 10701 in: path 10702 required: true 10703 schema: 10704 type: string 10705 - name: teamId 10706 in: path 10707 required: true 10708 schema: 10709 type: string 10710 - $ref: "#/components/parameters/FactoryWorkspace" 10711 - $ref: "#/components/parameters/IdempotencyKey" 10712 responses: 10713 "200": 10714 description: OK. 10715 content: 10716 application/json: 10717 schema: 10718 type: object 10719 "400": 10720 $ref: "#/components/responses/Err400" 10721 description: VALIDATION_ERROR — request validation failed. 10722 "401": 10723 $ref: "#/components/responses/Err401" 10724 description: UNAUTHORIZED — missing/invalid credentials. 10725 "403": 10726 $ref: "#/components/responses/Err403" 10727 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10728 "404": 10729 $ref: "#/components/responses/Err404" 10730 description: NOT_FOUND — resource does not exist for this caller. 10731 "409": 10732 $ref: "#/components/responses/Err409" 10733 description: CONFLICT — duplicate or state conflict. 10734 "429": 10735 $ref: "#/components/responses/Err429" 10736 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10737 "500": 10738 $ref: "#/components/responses/Err500" 10739 description: INTERNAL_ERROR — unexpected server error. 10740 delete: 10741 operationId: DeleteWorkspacesByWorkspaceIdTeamsByTeamId 10742 tags: 10743 - Teams 10744 summary: Delete teams by workspaceId + teamId 10745 security: 10746 - bearerAuth: [] 10747 parameters: 10748 - name: workspaceId 10749 in: path 10750 required: true 10751 schema: 10752 type: string 10753 - name: teamId 10754 in: path 10755 required: true 10756 schema: 10757 type: string 10758 - $ref: "#/components/parameters/FactoryWorkspace" 10759 - $ref: "#/components/parameters/IdempotencyKey" 10760 responses: 10761 "200": 10762 description: OK. 10763 content: 10764 application/json: 10765 schema: 10766 type: object 10767 "400": 10768 $ref: "#/components/responses/Err400" 10769 description: VALIDATION_ERROR — request validation failed. 10770 "401": 10771 $ref: "#/components/responses/Err401" 10772 description: UNAUTHORIZED — missing/invalid credentials. 10773 "403": 10774 $ref: "#/components/responses/Err403" 10775 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10776 "404": 10777 $ref: "#/components/responses/Err404" 10778 description: NOT_FOUND — resource does not exist for this caller. 10779 "429": 10780 $ref: "#/components/responses/Err429" 10781 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10782 "500": 10783 $ref: "#/components/responses/Err500" 10784 description: INTERNAL_ERROR — unexpected server error. 10785 /workspaces/{workspaceId}/teams/{teamId}/members: 10786 post: 10787 operationId: PostWorkspacesByWorkspaceIdTeamsByTeamIdMembers 10788 tags: 10789 - Teams 10790 summary: Create teams by workspaceId + teamId 10791 security: 10792 - bearerAuth: [] 10793 parameters: 10794 - name: workspaceId 10795 in: path 10796 required: true 10797 schema: 10798 type: string 10799 - name: teamId 10800 in: path 10801 required: true 10802 schema: 10803 type: string 10804 - $ref: "#/components/parameters/FactoryWorkspace" 10805 - $ref: "#/components/parameters/IdempotencyKey" 10806 responses: 10807 "200": 10808 description: OK. 10809 content: 10810 application/json: 10811 schema: 10812 type: object 10813 "400": 10814 $ref: "#/components/responses/Err400" 10815 description: VALIDATION_ERROR — request validation failed. 10816 "401": 10817 $ref: "#/components/responses/Err401" 10818 description: UNAUTHORIZED — missing/invalid credentials. 10819 "403": 10820 $ref: "#/components/responses/Err403" 10821 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10822 "404": 10823 $ref: "#/components/responses/Err404" 10824 description: NOT_FOUND — resource does not exist for this caller. 10825 "429": 10826 $ref: "#/components/responses/Err429" 10827 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10828 "500": 10829 $ref: "#/components/responses/Err500" 10830 description: INTERNAL_ERROR — unexpected server error. 10831 /workspaces/{workspaceId}/teams/{teamId}/members/{userId}: 10832 delete: 10833 operationId: DeleteWorkspacesByWorkspaceIdTeamsByTeamIdMembersByUserId 10834 tags: 10835 - Teams 10836 summary: Delete teams by workspaceId + teamId + userId 10837 security: 10838 - bearerAuth: [] 10839 parameters: 10840 - name: workspaceId 10841 in: path 10842 required: true 10843 schema: 10844 type: string 10845 - name: teamId 10846 in: path 10847 required: true 10848 schema: 10849 type: string 10850 - name: userId 10851 in: path 10852 required: true 10853 schema: 10854 type: string 10855 - $ref: "#/components/parameters/FactoryWorkspace" 10856 - $ref: "#/components/parameters/IdempotencyKey" 10857 responses: 10858 "200": 10859 description: OK. 10860 content: 10861 application/json: 10862 schema: 10863 type: object 10864 "400": 10865 $ref: "#/components/responses/Err400" 10866 description: VALIDATION_ERROR — request validation failed. 10867 "401": 10868 $ref: "#/components/responses/Err401" 10869 description: UNAUTHORIZED — missing/invalid credentials. 10870 "403": 10871 $ref: "#/components/responses/Err403" 10872 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10873 "404": 10874 $ref: "#/components/responses/Err404" 10875 description: NOT_FOUND — resource does not exist for this caller. 10876 "429": 10877 $ref: "#/components/responses/Err429" 10878 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10879 "500": 10880 $ref: "#/components/responses/Err500" 10881 description: INTERNAL_ERROR — unexpected server error. 10882 /workspaces/{workspaceId}/templates: 10883 get: 10884 operationId: GetWorkspacesByWorkspaceIdTemplates 10885 tags: 10886 - Templates 10887 summary: List workspace templates 10888 security: 10889 - bearerAuth: [] 10890 parameters: 10891 - name: workspaceId 10892 in: path 10893 required: true 10894 schema: 10895 type: string 10896 - $ref: "#/components/parameters/FactoryWorkspace" 10897 responses: 10898 "200": 10899 description: OK. 10900 content: 10901 application/json: 10902 schema: 10903 type: object 10904 "401": 10905 $ref: "#/components/responses/Err401" 10906 description: UNAUTHORIZED — missing/invalid credentials. 10907 "403": 10908 $ref: "#/components/responses/Err403" 10909 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10910 "404": 10911 $ref: "#/components/responses/Err404" 10912 description: NOT_FOUND — resource does not exist for this caller. 10913 "429": 10914 $ref: "#/components/responses/Err429" 10915 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10916 "500": 10917 $ref: "#/components/responses/Err500" 10918 description: INTERNAL_ERROR — unexpected server error. 10919 /workspaces/{workspaceId}/webhooks: 10920 post: 10921 operationId: PostWorkspacesByWorkspaceIdWebhooks 10922 tags: 10923 - Webhooks 10924 summary: Create webhooks by workspaceId 10925 security: 10926 - bearerAuth: [] 10927 parameters: 10928 - name: workspaceId 10929 in: path 10930 required: true 10931 schema: 10932 type: string 10933 - $ref: "#/components/parameters/FactoryWorkspace" 10934 - $ref: "#/components/parameters/IdempotencyKey" 10935 responses: 10936 "201": 10937 description: The created resource. 10938 content: 10939 application/json: 10940 schema: 10941 type: object 10942 "400": 10943 $ref: "#/components/responses/Err400" 10944 description: VALIDATION_ERROR — request validation failed. 10945 "401": 10946 $ref: "#/components/responses/Err401" 10947 description: UNAUTHORIZED — missing/invalid credentials. 10948 "403": 10949 $ref: "#/components/responses/Err403" 10950 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10951 "404": 10952 $ref: "#/components/responses/Err404" 10953 description: NOT_FOUND — resource does not exist for this caller. 10954 "409": 10955 $ref: "#/components/responses/Err409" 10956 description: CONFLICT — duplicate or state conflict. 10957 "429": 10958 $ref: "#/components/responses/Err429" 10959 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10960 "500": 10961 $ref: "#/components/responses/Err500" 10962 description: INTERNAL_ERROR — unexpected server error. 10963 get: 10964 operationId: GetWorkspacesByWorkspaceIdWebhooks 10965 tags: 10966 - Webhooks 10967 summary: Get webhooks by workspaceId 10968 security: 10969 - bearerAuth: [] 10970 parameters: 10971 - name: workspaceId 10972 in: path 10973 required: true 10974 schema: 10975 type: string 10976 - $ref: "#/components/parameters/FactoryWorkspace" 10977 responses: 10978 "200": 10979 description: OK. 10980 content: 10981 application/json: 10982 schema: 10983 type: object 10984 "401": 10985 $ref: "#/components/responses/Err401" 10986 description: UNAUTHORIZED — missing/invalid credentials. 10987 "403": 10988 $ref: "#/components/responses/Err403" 10989 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 10990 "404": 10991 $ref: "#/components/responses/Err404" 10992 description: NOT_FOUND — resource does not exist for this caller. 10993 "429": 10994 $ref: "#/components/responses/Err429" 10995 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 10996 "500": 10997 $ref: "#/components/responses/Err500" 10998 description: INTERNAL_ERROR — unexpected server error. 10999 /workspaces/{workspaceId}/webhooks/{webhookId}: 11000 get: 11001 operationId: GetWorkspacesByWorkspaceIdWebhooksByWebhookId 11002 tags: 11003 - Webhooks 11004 summary: Get webhooks by workspaceId + webhookId 11005 security: 11006 - bearerAuth: [] 11007 parameters: 11008 - name: workspaceId 11009 in: path 11010 required: true 11011 schema: 11012 type: string 11013 - name: webhookId 11014 in: path 11015 required: true 11016 schema: 11017 type: string 11018 - $ref: "#/components/parameters/FactoryWorkspace" 11019 responses: 11020 "200": 11021 description: OK. 11022 content: 11023 application/json: 11024 schema: 11025 type: object 11026 "401": 11027 $ref: "#/components/responses/Err401" 11028 description: UNAUTHORIZED — missing/invalid credentials. 11029 "403": 11030 $ref: "#/components/responses/Err403" 11031 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11032 "404": 11033 $ref: "#/components/responses/Err404" 11034 description: NOT_FOUND — resource does not exist for this caller. 11035 "429": 11036 $ref: "#/components/responses/Err429" 11037 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11038 "500": 11039 $ref: "#/components/responses/Err500" 11040 description: INTERNAL_ERROR — unexpected server error. 11041 patch: 11042 operationId: PatchWorkspacesByWorkspaceIdWebhooksByWebhookId 11043 tags: 11044 - Webhooks 11045 summary: Update webhooks by workspaceId + webhookId 11046 security: 11047 - bearerAuth: [] 11048 parameters: 11049 - name: workspaceId 11050 in: path 11051 required: true 11052 schema: 11053 type: string 11054 - name: webhookId 11055 in: path 11056 required: true 11057 schema: 11058 type: string 11059 - $ref: "#/components/parameters/FactoryWorkspace" 11060 - $ref: "#/components/parameters/IdempotencyKey" 11061 responses: 11062 "200": 11063 description: OK. 11064 content: 11065 application/json: 11066 schema: 11067 type: object 11068 "400": 11069 $ref: "#/components/responses/Err400" 11070 description: VALIDATION_ERROR — request validation failed. 11071 "401": 11072 $ref: "#/components/responses/Err401" 11073 description: UNAUTHORIZED — missing/invalid credentials. 11074 "403": 11075 $ref: "#/components/responses/Err403" 11076 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11077 "404": 11078 $ref: "#/components/responses/Err404" 11079 description: NOT_FOUND — resource does not exist for this caller. 11080 "409": 11081 $ref: "#/components/responses/Err409" 11082 description: CONFLICT — duplicate or state conflict. 11083 "429": 11084 $ref: "#/components/responses/Err429" 11085 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11086 "500": 11087 $ref: "#/components/responses/Err500" 11088 description: INTERNAL_ERROR — unexpected server error. 11089 delete: 11090 operationId: DeleteWorkspacesByWorkspaceIdWebhooksByWebhookId 11091 tags: 11092 - Webhooks 11093 summary: Delete webhooks by workspaceId + webhookId 11094 security: 11095 - bearerAuth: [] 11096 parameters: 11097 - name: workspaceId 11098 in: path 11099 required: true 11100 schema: 11101 type: string 11102 - name: webhookId 11103 in: path 11104 required: true 11105 schema: 11106 type: string 11107 - $ref: "#/components/parameters/FactoryWorkspace" 11108 - $ref: "#/components/parameters/IdempotencyKey" 11109 responses: 11110 "200": 11111 description: OK. 11112 content: 11113 application/json: 11114 schema: 11115 type: object 11116 "400": 11117 $ref: "#/components/responses/Err400" 11118 description: VALIDATION_ERROR — request validation failed. 11119 "401": 11120 $ref: "#/components/responses/Err401" 11121 description: UNAUTHORIZED — missing/invalid credentials. 11122 "403": 11123 $ref: "#/components/responses/Err403" 11124 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11125 "404": 11126 $ref: "#/components/responses/Err404" 11127 description: NOT_FOUND — resource does not exist for this caller. 11128 "429": 11129 $ref: "#/components/responses/Err429" 11130 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11131 "500": 11132 $ref: "#/components/responses/Err500" 11133 description: INTERNAL_ERROR — unexpected server error. 11134 /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries: 11135 get: 11136 operationId: GetWorkspacesByWorkspaceIdWebhooksByWebhookIdDeliveries 11137 tags: 11138 - Webhooks 11139 summary: Get webhooks by workspaceId + webhookId 11140 security: 11141 - bearerAuth: [] 11142 parameters: 11143 - name: workspaceId 11144 in: path 11145 required: true 11146 schema: 11147 type: string 11148 - name: webhookId 11149 in: path 11150 required: true 11151 schema: 11152 type: string 11153 - $ref: "#/components/parameters/FactoryWorkspace" 11154 responses: 11155 "200": 11156 description: OK. 11157 content: 11158 application/json: 11159 schema: 11160 type: object 11161 "401": 11162 $ref: "#/components/responses/Err401" 11163 description: UNAUTHORIZED — missing/invalid credentials. 11164 "403": 11165 $ref: "#/components/responses/Err403" 11166 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11167 "404": 11168 $ref: "#/components/responses/Err404" 11169 description: NOT_FOUND — resource does not exist for this caller. 11170 "429": 11171 $ref: "#/components/responses/Err429" 11172 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11173 "500": 11174 $ref: "#/components/responses/Err500" 11175 description: INTERNAL_ERROR — unexpected server error. 11176 /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/{deliveryId}: 11177 get: 11178 operationId: GetWorkspacesByWorkspaceIdWebhooksByWebhookIdDeliveriesByDeliveryId 11179 tags: 11180 - Webhooks 11181 summary: Get webhooks by workspaceId + webhookId + deliveryId 11182 security: 11183 - bearerAuth: [] 11184 parameters: 11185 - name: workspaceId 11186 in: path 11187 required: true 11188 schema: 11189 type: string 11190 - name: webhookId 11191 in: path 11192 required: true 11193 schema: 11194 type: string 11195 - name: deliveryId 11196 in: path 11197 required: true 11198 schema: 11199 type: string 11200 - $ref: "#/components/parameters/FactoryWorkspace" 11201 responses: 11202 "200": 11203 description: OK. 11204 content: 11205 application/json: 11206 schema: 11207 type: object 11208 "401": 11209 $ref: "#/components/responses/Err401" 11210 description: UNAUTHORIZED — missing/invalid credentials. 11211 "403": 11212 $ref: "#/components/responses/Err403" 11213 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11214 "404": 11215 $ref: "#/components/responses/Err404" 11216 description: NOT_FOUND — resource does not exist for this caller. 11217 "429": 11218 $ref: "#/components/responses/Err429" 11219 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11220 "500": 11221 $ref: "#/components/responses/Err500" 11222 description: INTERNAL_ERROR — unexpected server error. 11223 /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/{deliveryId}/retry: 11224 post: 11225 operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdDeliveriesByDeliveryIdRetry 11226 tags: 11227 - Webhooks 11228 summary: Create webhooks by workspaceId + webhookId + deliveryId 11229 security: 11230 - bearerAuth: [] 11231 parameters: 11232 - name: workspaceId 11233 in: path 11234 required: true 11235 schema: 11236 type: string 11237 - name: webhookId 11238 in: path 11239 required: true 11240 schema: 11241 type: string 11242 - name: deliveryId 11243 in: path 11244 required: true 11245 schema: 11246 type: string 11247 - $ref: "#/components/parameters/FactoryWorkspace" 11248 - $ref: "#/components/parameters/IdempotencyKey" 11249 responses: 11250 "200": 11251 description: OK. 11252 content: 11253 application/json: 11254 schema: 11255 type: object 11256 "400": 11257 $ref: "#/components/responses/Err400" 11258 description: VALIDATION_ERROR — request validation failed. 11259 "401": 11260 $ref: "#/components/responses/Err401" 11261 description: UNAUTHORIZED — missing/invalid credentials. 11262 "403": 11263 $ref: "#/components/responses/Err403" 11264 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11265 "404": 11266 $ref: "#/components/responses/Err404" 11267 description: NOT_FOUND — resource does not exist for this caller. 11268 "429": 11269 $ref: "#/components/responses/Err429" 11270 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11271 "500": 11272 $ref: "#/components/responses/Err500" 11273 description: INTERNAL_ERROR — unexpected server error. 11274 /workspaces/{workspaceId}/webhooks/{webhookId}/resubmit: 11275 post: 11276 operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdResubmit 11277 tags: 11278 - Webhooks 11279 summary: Create webhooks by workspaceId + webhookId 11280 security: 11281 - bearerAuth: [] 11282 parameters: 11283 - name: workspaceId 11284 in: path 11285 required: true 11286 schema: 11287 type: string 11288 - name: webhookId 11289 in: path 11290 required: true 11291 schema: 11292 type: string 11293 - $ref: "#/components/parameters/FactoryWorkspace" 11294 - $ref: "#/components/parameters/IdempotencyKey" 11295 responses: 11296 "200": 11297 description: OK. 11298 content: 11299 application/json: 11300 schema: 11301 type: object 11302 "400": 11303 $ref: "#/components/responses/Err400" 11304 description: VALIDATION_ERROR — request validation failed. 11305 "401": 11306 $ref: "#/components/responses/Err401" 11307 description: UNAUTHORIZED — missing/invalid credentials. 11308 "403": 11309 $ref: "#/components/responses/Err403" 11310 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11311 "404": 11312 $ref: "#/components/responses/Err404" 11313 description: NOT_FOUND — resource does not exist for this caller. 11314 "429": 11315 $ref: "#/components/responses/Err429" 11316 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11317 "500": 11318 $ref: "#/components/responses/Err500" 11319 description: INTERNAL_ERROR — unexpected server error. 11320 /workspaces/{workspaceId}/webhooks/{webhookId}/rotate-secret: 11321 post: 11322 operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdRotateSecret 11323 tags: 11324 - Webhooks 11325 summary: Create webhooks by workspaceId + webhookId 11326 security: 11327 - bearerAuth: [] 11328 parameters: 11329 - name: workspaceId 11330 in: path 11331 required: true 11332 schema: 11333 type: string 11334 - name: webhookId 11335 in: path 11336 required: true 11337 schema: 11338 type: string 11339 - $ref: "#/components/parameters/FactoryWorkspace" 11340 - $ref: "#/components/parameters/IdempotencyKey" 11341 responses: 11342 "200": 11343 description: OK. 11344 content: 11345 application/json: 11346 schema: 11347 type: object 11348 "400": 11349 $ref: "#/components/responses/Err400" 11350 description: VALIDATION_ERROR — request validation failed. 11351 "401": 11352 $ref: "#/components/responses/Err401" 11353 description: UNAUTHORIZED — missing/invalid credentials. 11354 "403": 11355 $ref: "#/components/responses/Err403" 11356 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11357 "404": 11358 $ref: "#/components/responses/Err404" 11359 description: NOT_FOUND — resource does not exist for this caller. 11360 "429": 11361 $ref: "#/components/responses/Err429" 11362 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11363 "500": 11364 $ref: "#/components/responses/Err500" 11365 description: INTERNAL_ERROR — unexpected server error. 11366 /workspaces/{workspaceId}/webhooks/{webhookId}/test: 11367 post: 11368 operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdTest 11369 tags: 11370 - Webhooks 11371 summary: Create webhooks by workspaceId + webhookId 11372 security: 11373 - bearerAuth: [] 11374 parameters: 11375 - name: workspaceId 11376 in: path 11377 required: true 11378 schema: 11379 type: string 11380 - name: webhookId 11381 in: path 11382 required: true 11383 schema: 11384 type: string 11385 - $ref: "#/components/parameters/FactoryWorkspace" 11386 - $ref: "#/components/parameters/IdempotencyKey" 11387 responses: 11388 "200": 11389 description: OK. 11390 content: 11391 application/json: 11392 schema: 11393 type: object 11394 "400": 11395 $ref: "#/components/responses/Err400" 11396 description: VALIDATION_ERROR — request validation failed. 11397 "401": 11398 $ref: "#/components/responses/Err401" 11399 description: UNAUTHORIZED — missing/invalid credentials. 11400 "403": 11401 $ref: "#/components/responses/Err403" 11402 description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). 11403 "404": 11404 $ref: "#/components/responses/Err404" 11405 description: NOT_FOUND — resource does not exist for this caller. 11406 "429": 11407 $ref: "#/components/responses/Err429" 11408 description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). 11409 "500": 11410 $ref: "#/components/responses/Err500" 11411 description: INTERNAL_ERROR — unexpected server error. 11412components: 11413 securitySchemes: 11414 bearerAuth: 11415 type: http 11416 scheme: bearer 11417 bearerFormat: JWT or API key (fk_…) 11418 description: User session JWT, or an `fk_` API key (the key acts as its workspace; scopes READ/WRITE/ADMIN). 11419 parameters: 11420 FactoryWorkspace: 11421 name: X-Factory-Workspace 11422 in: header 11423 required: false 11424 description: "Optional workspace context. For API keys: if present, MUST equal the key's own workspace (else 403 11425 workspace_mismatch). For users: if the JWT covers several workspaces, selects the active one (must be a 11426 membership). The path's `:workspaceId` segment is the authoritative selector on workspace-scoped routes." 11427 schema: 11428 type: string 11429 IdempotencyKey: 11430 name: Idempotency-Key 11431 in: header 11432 required: false 11433 description: "Client-chosen unique key (≤ 128 chars). A repeated key within 24 h replays the stored 2xx response (header 11434 `Idempotency-Replayed: true`) instead of re-executing." 11435 schema: 11436 type: string 11437 maxLength: 128 11438 schemas: 11439 ErrorDetail: 11440 type: object 11441 properties: 11442 reason: 11443 type: string 11444 description: Machine-readable reason (e.g. api_key_scope_write, workspace_mismatch, requires_user_credentials). 11445 field: 11446 type: string 11447 description: "Validation: the offending field." 11448 issue: 11449 type: string 11450 description: "Validation: the issue (required, already_exists, …)." 11451 ErrorResponse: 11452 type: object 11453 required: 11454 - error 11455 properties: 11456 error: 11457 type: object 11458 required: 11459 - code 11460 - message 11461 - requestId 11462 properties: 11463 code: 11464 type: string 11465 description: Canonical error code (VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, UNPROCESSABLE_ENTITY, 11466 PAYLOAD_TOO_LARGE, RATE_LIMITED, INTERNAL_ERROR, …). 11467 message: 11468 type: string 11469 details: 11470 type: array 11471 items: 11472 $ref: "#/components/schemas/ErrorDetail" 11473 requestId: 11474 type: string 11475 responses: 11476 Err400: 11477 description: Validation failed. 11478 content: 11479 application/json: 11480 schema: 11481 $ref: "#/components/schemas/ErrorResponse" 11482 Err401: 11483 description: Unauthenticated. 11484 content: 11485 application/json: 11486 schema: 11487 $ref: "#/components/schemas/ErrorResponse" 11488 Err403: 11489 description: Forbidden (permission / API-key scope / workspace mismatch). 11490 content: 11491 application/json: 11492 schema: 11493 $ref: "#/components/schemas/ErrorResponse" 11494 Err404: 11495 description: Not found. 11496 content: 11497 application/json: 11498 schema: 11499 $ref: "#/components/schemas/ErrorResponse" 11500 Err409: 11501 description: Conflict. 11502 content: 11503 application/json: 11504 schema: 11505 $ref: "#/components/schemas/ErrorResponse" 11506 Err422: 11507 description: Unprocessable (domain validation). 11508 content: 11509 application/json: 11510 schema: 11511 $ref: "#/components/schemas/ErrorResponse" 11512 Err429: 11513 description: Rate limited. 11514 content: 11515 application/json: 11516 schema: 11517 $ref: "#/components/schemas/ErrorResponse" 11518 Err500: 11519 description: Internal error. 11520 content: 11521 application/json: 11522 schema: 11523 $ref: "#/components/schemas/ErrorResponse" 11524