{"openapi":"3.1.0","info":{"title":"Cradle API","version":"0.0.0"},"paths":{"/500":{"get":{"tags":["Platform Admin"],"summary":"Error","description":"Raises a 500 error. This is a test endpoint for verifying error handling and alerting, if triggering please notify #eng-alerts-platform to avoid false alarms.","operationId":"central.error","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/v2/workspace:create":{"post":{"tags":["Workspaces"],"summary":"Create Workspace","description":"Create a new workspace.","operationId":"workspace.create_workspace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/v2/workspace:delete":{"post":{"tags":["Workspaces"],"summary":"Delete Workspace","description":"Delete a workspace and all of its resources. This is a destructive operation that takes some time to complete.\n\nActual deletion of infrastructure resources associated with the workspace only occurs after a retention period.\nOnce the retention period has expired, the workspace state transitions from `DELETING` to `DELETED`.","operationId":"workspace.delete_workspace","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"Name of the workspace in which to perform the operation.","title":"Name"},"description":"Name of the workspace in which to perform the operation."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/v2/workspace:restore":{"post":{"tags":["Workspaces"],"summary":"Restore Workspace","description":"Restores a workspace that has been deleted with the `:delete` endpoint.\n\nThis works as long as the workspace is still in `DELETING` state and has not reached `DELETED` yet. By default,\nthis retention period is 7 days.","operationId":"workspace.restore_workspace","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"Name of the workspace in which to perform the operation.","title":"Name"},"description":"Name of the workspace in which to perform the operation."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/v2/workspace:updateCapabilities":{"post":{"tags":["Workspaces"],"summary":"Update Workspace Capabilities","description":"Update the capabilities of a workspace.\n\nCapabilities that are omitted from the request are left unchanged.","operationId":"workspace.update_workspace_capabilities","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"Name of the workspace in which to perform the operation.","title":"Name"},"description":"Name of the workspace in which to perform the operation."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceCapabilitiesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/v2/workspace:getRecord":{"get":{"tags":["Workspaces"],"summary":"Get Workspace Record","operationId":"workspace.get_workspace_record","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"Name of the workspace in which to perform the operation.","title":"Name"},"description":"Name of the workspace in which to perform the operation."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRecordResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-deployment-plane":"CENTRAL"}},"/v2/workspace:listRecords":{"get":{"tags":["Workspaces"],"summary":"Get Workspace Records","description":"List all workspace records the user has access to","operationId":"workspace.get_workspace_records","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"include_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include records that have been deleted","default":false,"title":"Include Deleted"},"description":"Include records that have been deleted"},{"name":"include_all","in":"query","required":false,"schema":{"type":"boolean","description":"Include all records, even those the user does not have access to","internal":true,"default":false,"title":"Include All"},"description":"Include all records, even those the user does not have access to"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRecordListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-deployment-plane":"CENTRAL"}},"/auth:apiStrategy":{"get":{"tags":["Authentication"],"summary":"Auth Api Strategy","description":"Get the auth strategy the SDK should use to login.","operationId":"auth.auth_api_strategy","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkOsAuthStrategy"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/auth:checkAuth":{"get":{"tags":["Authentication"],"summary":"Auth Api Strategy Authed","description":"Tell the SDK whether its current token can reach `workspace`, and if not, whether re-auth would help.\n\nThe caller is already authenticated; the only question is whether their token is scoped to the right\nWorkOS org for this workspace. Returns one of three outcomes:\n\n1. `AuthorizedResponse`: the token already works for this workspace, the user is signed into it, or is a\n  cradle employee (`platform.inspect`) whose access is identity-based regionally regardless of org scope.\n2. `UnauthorizedResponse(can_reauth=True, org_id=...)`: the token is valid but scoped to the wrong org; the\n  user is a member of the workspace's org, so the SDK should refresh its token against `org_id`.\n3. `UnauthorizedResponse(can_reauth=False)`: the workspace doesn't exist in WorkOS, or the user has no\n  membership to re-scope to, re-auth wouldn't help, so the SDK just proceeds on its existing token.","operationId":"auth.auth_api_strategy_authed","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"workspace","in":"query","required":true,"schema":{"type":"string","title":"Workspace"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UnauthorizedResponse"},{"$ref":"#/components/schemas/AuthorizedResponse"}],"discriminator":{"propertyName":"authorized","mapping":{"False":"#/components/schemas/UnauthorizedResponse","True":"#/components/schemas/AuthorizedResponse"}},"title":"Response Auth.Auth Api Strategy Authed"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/auth/docs:authorize":{"get":{"tags":["Documentation"],"summary":"Authorize","description":"Mint a Document360 login code for the current reader and return the knowledge-base redirect URL.","operationId":"docs.authorize","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"redirect_url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Redirect Url"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/users/me":{"get":{"tags":["Users"],"summary":"Get Current User","operationId":"users.get_current_user","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"},"patch":{"tags":["Users"],"summary":"Edit User","operationId":"users.edit_user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditUserRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/users/list":{"get":{"tags":["Users"],"summary":"List Users","operationId":"users.list_users","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/users/me/picture":{"post":{"tags":["Users"],"summary":"Set User Profile Picture","operationId":"users.set_user_profile_picture","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/set_user_profile_picture"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"},"delete":{"tags":["Users"],"summary":"Delete User Profile Picture","operationId":"users.delete_user_profile_picture","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/workos/webhook":{"post":{"tags":["WorkOS"],"summary":"Workos Webhook","operationId":"workos.workos_webhook","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"workos-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workos-Signature"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Workos.Workos Webhook"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/workos/webhook/{_webhook_path}":{"post":{"tags":["WorkOS"],"summary":"Workos Webhook With Suffix","operationId":"workos.workos_webhook_with_suffix","security":[{"app.cradle.bio":[]}],"parameters":[{"name":"_webhook_path","in":"path","required":true,"schema":{"type":"string","title":" Webhook Path"}},{"name":"workos-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workos-Signature"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Workos.Workos Webhook With Suffix"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/workos:revokeSessions":{"post":{"tags":["WorkOS"],"summary":"Revoke Sessions","description":"Revoke all sessions for a user.","operationId":"workos.revoke_sessions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Workos.Revoke Sessions"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/workos:addRadarAllowEntry":{"post":{"tags":["WorkOS"],"summary":"Add Radar Allow Entry","description":"Add a radar (workos threat-detection) allow entry.","operationId":"workos.add_radar_allow_entry","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRadarAllowEntryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}},"/ui/workspace:getOverview":{"get":{"tags":["Workspaces","UI"],"summary":"Overview All","description":"Overview over the status of all workspaces.","operationId":"workspace.ui_router.overview_all","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceOverview"}}}}},"security":[{"app.cradle.bio":[]}],"x-internal":true,"x-deployment-plane":"CENTRAL"}}},"components":{"schemas":{"AddRadarAllowEntryRequest":{"properties":{"type":{"type":"string","enum":["ip_address","domain","email","device","user_agent","device_fingerprint"],"title":"Type"},"entry":{"type":"string","title":"Entry"}},"type":"object","required":["type","entry"],"title":"AddRadarAllowEntryRequest"},"AuthorizeResponse":{"properties":{"redirect_url":{"type":"string","title":"Redirect Url"}},"type":"object","required":["redirect_url"],"title":"AuthorizeResponse"},"AuthorizedResponse":{"properties":{"authorized":{"type":"boolean","const":true,"title":"Authorized","default":true}},"type":"object","title":"AuthorizedResponse"},"DeploymentRegion":{"type":"string","enum":["EU","US"],"title":"DeploymentRegion"},"EditUserRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Name"}},"type":"object","title":"EditUserRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ListUsersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","title":"Items"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor with which the next page of entries can be retrieved. If no cursor is returned, no further pages exist."}},"type":"object","required":["items","cursor"],"title":"ListUsersResponse"},"SuccessResponse":{"properties":{"detail":{"type":"string","title":"Detail","default":"Success"}},"type":"object","title":"SuccessResponse","description":"Generic success response"},"TaskOverview":{"properties":{"failed_user":{"type":"integer","title":"Failed User"},"failed_internal":{"type":"integer","title":"Failed Internal"},"succeeded":{"type":"integer","title":"Succeeded"},"pending":{"type":"integer","title":"Pending"},"workspaces":{"items":{"$ref":"#/components/schemas/_WorkspaceTaskOverview"},"type":"array","title":"Workspaces"}},"type":"object","required":["failed_user","failed_internal","succeeded","pending","workspaces"],"title":"TaskOverview"},"UnauthorizedResponse":{"properties":{"authorized":{"type":"boolean","const":false,"title":"Authorized","default":false},"can_reauth":{"type":"boolean","title":"Can Reauth"},"org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Id"}},"type":"object","required":["can_reauth","org_id"],"title":"UnauthorizedResponse"},"UpdateWorkspaceCapabilitiesRequest":{"properties":{"can_generate_variants":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Can Generate Variants"}},"type":"object","title":"UpdateWorkspaceCapabilitiesRequest","description":"Partial update of a workspace's capabilities: `None` leaves that capability unchanged."},"UserResponse":{"properties":{"type":{"type":"string","const":"user","title":"Type","default":"user"},"user_id":{"type":"string","maxLength":200,"title":"User Id"},"name":{"type":"string","maxLength":200,"title":"Name"},"email":{"type":"string","maxLength":200,"title":"Email"},"picture":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Picture"},"picture_file_id":{"anyOf":[{"type":"string","format":"int64"},{"type":"null"}],"title":"Picture File Id"},"user_type":{"$ref":"#/components/schemas/UserType"},"last_sign_in_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sign In At"}},"type":"object","required":["user_id","name","email","user_type"],"title":"UserResponse"},"UserType":{"type":"string","enum":["USER","M2M"],"title":"UserType"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WorkOsAuthStrategy":{"properties":{"strategy":{"type":"string","const":"workos","title":"Strategy","default":"workos"},"client_id":{"type":"string","title":"Client Id"},"app_url":{"type":"string","title":"App Url"},"auth_api_url":{"type":"string","title":"Auth Api Url"}},"type":"object","required":["client_id","app_url","auth_api_url"],"title":"WorkOsAuthStrategy"},"WorkspaceCapabilities":{"properties":{"can_generate_variants":{"type":"boolean","title":"Can Generate Variants","default":true}},"type":"object","title":"WorkspaceCapabilities"},"WorkspaceCreate":{"properties":{"name":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$","title":"Name","description":"The unique workspace name, it must be a valid DNS label as it will be used in URLs."},"display_name":{"type":"string","maxLength":200,"minLength":1,"title":"Display Name","description":"The human-readable name of the workspace."},"region":{"anyOf":[{"$ref":"#/components/schemas/DeploymentRegion"},{"type":"null"}]},"capabilities":{"$ref":"#/components/schemas/WorkspaceCapabilities","description":"**[INTERNAL]** ","x-cradle-visibility":"internal","x-internal":true}},"type":"object","required":["name","display_name"],"title":"WorkspaceCreate"},"WorkspaceOverview":{"properties":{"tasks":{"$ref":"#/components/schemas/TaskOverview"}},"type":"object","required":["tasks"],"title":"WorkspaceOverview"},"WorkspaceRecordListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkspaceRecordResponse"},"type":"array","title":"Items"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor with which the next page of entries can be retrieved. If no cursor is returned, no further pages exist."}},"type":"object","required":["items","cursor"],"title":"WorkspaceRecordListResponse"},"WorkspaceRecordResponse":{"properties":{"id":{"type":"string","format":"int64","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The time at which the resource was created"},"created_by":{"type":"string","title":"Created By","description":"The ID of the user who created the resource"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The time at which the resource was last updated"},"updated_by":{"type":"string","title":"Updated By","description":"The ID of the user who last updated the resource"},"name":{"type":"string","title":"Name"},"region":{"$ref":"#/components/schemas/DeploymentRegion","description":"The region where the workspace is provisioned."},"region_api_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Region Api Url","description":"The regional API URL of the workspace."},"workos_org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workos Org Id","description":"WorkOS organization ID of the workspace. None if workos is not enabled or the workspace is not associated with a WorkOS organization.","x-cradle-visibility":"hidden","x-internal":true},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"deleted_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deleted By"}},"type":"object","required":["id","created_at","created_by","updated_at","updated_by","name","region","region_api_url","workos_org_id","deleted_at","deleted_by"],"title":"WorkspaceRecordResponse"},"WorkspaceResponse":{"properties":{"errors":{"items":{"type":"string"},"type":"array","title":"Errors","description":"List of error messages associated with the resource."},"internal_error_details":{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array","title":"Internal Error Details","description":"List of internal error messages associated with the `errors` field.","x-cradle-visibility":"internal","x-internal":true},"id":{"type":"string","format":"int64","title":"Id","description":"The unique identifier of the resource"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The time at which the resource was created"},"created_by":{"type":"string","title":"Created By","description":"The ID of the user who created the resource"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The time at which the resource was last updated"},"updated_by":{"type":"string","title":"Updated By","description":"The ID of the user who last updated the resource"},"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"state":{"$ref":"#/components/schemas/WorkspaceState"},"picture_file_id":{"anyOf":[{"type":"string","format":"int64"},{"type":"null"}],"title":"Picture File Id"},"capabilities":{"$ref":"#/components/schemas/WorkspaceCapabilities","description":"**[INTERNAL]** ","x-cradle-visibility":"internal","x-internal":true}},"type":"object","required":["id","created_at","created_by","updated_at","updated_by","name","display_name","state","picture_file_id","capabilities"],"title":"WorkspaceResponse","x-internal":true},"WorkspaceState":{"type":"string","enum":["PROVISIONING","DELETING","READY","FAILED"],"title":"WorkspaceState"},"_OverviewTask":{"properties":{"id":{"type":"string","format":"int64","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","created_at"],"title":"_OverviewTask"},"_WorkspaceTaskOverview":{"properties":{"name":{"type":"string","title":"Name"},"failed_user":{"type":"integer","title":"Failed User"},"failed_internal":{"type":"integer","title":"Failed Internal"},"succeeded":{"type":"integer","title":"Succeeded"},"pending":{"type":"integer","title":"Pending"},"oldest_pending":{"anyOf":[{"$ref":"#/components/schemas/_OverviewTask"},{"type":"null"}]}},"type":"object","required":["name","failed_user","failed_internal","succeeded","pending","oldest_pending"],"title":"_WorkspaceTaskOverview"},"set_user_profile_picture":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_users.set_user_profile_picture"}},"securitySchemes":{"app.cradle.bio":{"type":"http","scheme":"bearer"}}},"tags":[{"name":"Workspaces","description":"\nThe workspace API provides functionality for retrieving information about your workspace.\n\nA workspace is the home for all data, projects, and tasks for an organization. By\ndesign no information can be shared across workspaces, they are the top-level\nconcept in the Cradle API.\n\nWorkspace creation and management is only available to Cradle administrators.\n"},{"name":"WorkOS","description":"\nEndpoints backed by the WorkOS identity provider.\n\nThese are only mounted when the workspace is configured with a WorkOS-based authenticator. They cover\nWorkOS-specific membership and directory operations (the WorkOS-managed user lifecycle) as well as\nWorkOS platform integration such as inbound webhooks and session administration.\n"},{"name":"UI","description":"\nEndpoints that back the Cradle web application.\n\nThese are not part of the public API contract: they are marked `x-internal`, are tailored to the\nneeds of the UI, and may change without notice. They are documented only in the internal API spec.\n"},{"name":"Authentication","description":"\nAuthentication endpoints describe how clients authenticate against the API.\n\nThey expose the configured authentication strategy and let a client verify its current authenticated\nsession.\n"},{"name":"Platform Admin","description":"Platform administration endpoints used to operate and maintain the Cradle deployment."},{"name":"Users","description":"\nThe users API manages user accounts and profiles.\n\nIt covers the current user (`/me`), profile updates, profile pictures, and listing users known to the\nplatform.\n"},{"name":"Documentation","description":"\nEndpoints supporting access to the Cradle product documentation.\n\nThese authorize a user for the externally hosted documentation portal.\n"}]}