CRBN Tech Catalog
    CRBN Tech Catalog
    • /ai-bots
      POST
    • /ai-bots
      GET
    • /ai-bots/{id}
      DELETE
    • /ai-bots/{id}
      PATCH
    • /ai-bots/{id}
      PUT
    • /ai-bots/{id}
      GET
    • /ai-credit-quota-assignments
      POST
    • /ai-credit-quota-assignments
      GET
    • /ai-credit-quota-assignments/{id}
      DELETE
    • /ai-credit-quota-assignments/{id}
      PATCH
    • /ai-credit-quota-assignments/{id}
      PUT
    • /ai-credit-quota-assignments/{id}
      GET
    • /ai-credit-quotas
      POST
    • /ai-credit-quotas
      GET
    • /ai-credit-quotas/{id}
      DELETE
    • /ai-credit-quotas/{id}
      PATCH
    • /ai-credit-quotas/{id}
      PUT
    • /ai-credit-quotas/{id}
      GET
    • /ai-knowledge-source
      POST
    • /ai-knowledge-source
      GET
    • /ai-knowledge-source-file-references
      POST
    • /ai-knowledge-source-file-references
      GET
    • /ai-knowledge-source-file-references/{id}
      DELETE
    • /ai-knowledge-source-file-references/{id}
      PATCH
    • /ai-knowledge-source-file-references/{id}
      PUT
    • /ai-knowledge-source-file-references/{id}
      GET
    • /ai-knowledge-source/{id}
      DELETE
    • /ai-knowledge-source/{id}
      PATCH
    • /ai-knowledge-source/{id}
      PUT
    • /ai-knowledge-source/{id}
      GET
    • /ai-knowledge-source/{id}/credentials
      POST
    • /ai-message-card-layouts
      POST
    • /ai-message-card-layouts
      GET
    • /ai-message-card-layouts/{id}
      PATCH
    • /ai-message-card-layouts/{id}
      PUT
    • /ai-message-card-layouts/{id}
      GET
    • /ai-message-card-layouts/{id}
      DELETE
    • /ai-message-cards
      POST
    • /ai-message-cards
      GET
    • /ai-message-cards/{id}
      DELETE
    • /ai-message-cards/{id}
      PATCH
    • /ai-message-cards/{id}
      PUT
    • /ai-message-cards/{id}
      GET
    • /ai-message-file-association
      POST
    • /ai-message-file-association
      GET
    • /ai-message-file-association/{id}
      DELETE
    • /ai-message-file-association/{id}
      PATCH
    • /ai-message-file-association/{id}
      PUT
    • /ai-message-file-association/{id}
      GET
    • /ai-model-deployment-credentials
      POST
    • /ai-model-deployment-credentials
      GET
    • /ai-model-deployment-credentials/{id}
      PUT
    • /ai-model-deployment-credentials/{id}
      GET
    • /ai-model-deployment-credentials/{id}
      DELETE
    • /ai-model-deployment-credentials/{id}
      PATCH
    • /ai-model-deployment-credentials/{id}/credentials
      POST
    • /ai-skill-access-grants
      GET
    • /ai-skill-access-grants
      POST
    • /ai-skill-access-grants/{id}
      DELETE
    • /ai-skill-access-grants/{id}
      PATCH
    • /ai-skill-access-grants/{id}
      PUT
    • /ai-skill-access-grants/{id}
      GET
    • /ai-skill-step-types
      POST
    • /ai-skill-step-types
      GET
    • /ai-skill-step-types/{id}
      DELETE
    • /ai-skill-step-types/{id}
      PATCH
    • /ai-skill-step-types/{id}
      PUT
    • /ai-skill-step-types/{id}
      GET
    • /ai-skill-steps
      POST
    • /ai-skill-steps
      GET
    • /ai-skill-steps/{id}
      DELETE
    • /ai-skill-steps/{id}
      PATCH
    • /ai-skill-steps/{id}
      PUT
    • /ai-skill-steps/{id}
      GET
    • /ai-skills
      POST
    • /ai-skills
      GET
    • /ai-skills/{id}
      DELETE
    • /ai-skills/{id}
      PATCH
    • /ai-skills/{id}
      PUT
    • /ai-skills/{id}
      GET
    • /chat/conversation
      POST
    • /chat/conversation
      GET
    • /chat/conversation-modes
      POST
    • /chat/conversation-modes/{id}
      PUT
    • /chat/conversation/reasoning
      POST
    • /chat/conversation/reasoning/{id}
      PUT
    • /chat/conversation/{id}
      GET
    • /chat/conversation/{id}
      PUT
    • /chat/conversation/{id}/archive
      PUT
    • /chat/conversation/{id}/unarchive
      PUT
    • /chat/messages
      GET
    • /chat/messages/{id}/input
      PUT
    • /chat/messages/{id}/stop
      POST
    • /knowledge-source-types
      POST
    • /knowledge-source-types
      GET
    • /knowledge-source-types/{id}
      DELETE
    • /knowledge-source-types/{id}
      PATCH
    • /knowledge-source-types/{id}
      PUT
    • /knowledge-source-types/{id}
      GET
    • /llm-model-deployment-access
      POST
    • /llm-model-deployment-access
      GET
    • /llm-model-deployment-access/{id}
      DELETE
    • /llm-model-deployment-access/{id}
      PATCH
    • /llm-model-deployment-access/{id}
      PUT
    • /llm-model-deployment-access/{id}
      GET
    • /llm-model-deployments
      POST
    • /llm-model-deployments
      GET
    • /llm-model-deployments/{id}
      PUT
    • /llm-model-deployments/{id}
      GET
    • /llm-model-deployments/{id}
      DELETE
    • /llm-model-deployments/{id}
      PATCH
    • /llm-models
      POST
    • /llm-models
      GET
    • /llm-models/{id}
      DELETE
    • /llm-models/{id}
      PATCH
    • /llm-models/{id}
      PUT
    • /llm-models/{id}
      GET
    • /llm-pricing
      POST
    • /llm-pricing
      GET
    • /llm-pricing/{id}
      DELETE
    • /llm-pricing/{id}
      PATCH
    • /llm-pricing/{id}
      PUT
    • /llm-pricing/{id}
      GET
    • /logs
      GET
    • /logs/count
      GET
    • /logs/types
      GET
    • /metrics/conversation/count
      GET
    • /metrics/conversation/responses
      GET
    • /metrics/dau
      GET
    • /metrics/file/count/extension
      GET
    • /metrics/file/count/mime
      GET
    • /metrics/file/size/extension
      GET
    • /metrics/file/size/mime
      GET
    • /metrics/knowledge-source/sharepoint/file/discovered
      GET
    • /metrics/knowledge-source/sharepoint/file/processable
      GET
    • /metrics/knowledge-source/sharepoint/file/processed
      GET
    • /metrics/knowledge-source/sharepoint/file/synced
      GET
    • /metrics/knowledge-sources/sharepoint/sites
      GET
    • /metrics/mau
      GET
    • /metrics/messages
      GET
    • /metrics/messages/user
      GET
    • /metrics/messages/user-group
      GET
    • /metrics/skills/top
      GET
    • /metrics/tokens
      GET
    • /metrics/tokens/conversation
      GET
    • /metrics/tokens/message
      GET
    • /metrics/tokens/user
      GET
    • /metrics/tokens/user-group
      GET
    • /metrics/wau
      GET
    • /skill-schedules
      GET
    • /skill-schedules
      POST
    • /skill-schedules/{id}
      DELETE
    • /skill-schedules/{id}
      PATCH
    • /skill-schedules/{id}
      PUT
    • /skill-schedules/{id}
      GET
    • /skills/{id}/use
      POST
    • /skills/{id}/use/{conversation_id}
      PUT

      /ai-skills

      GET
      /ai-skills
      Foundational GET all handler for: ai-skills
      This is a Skill that is created to be used by an AI bot.
      Each Skill is defined, with a set of steps that it will take.
      Each Skill Step has a Type that can be associated with it.
      Each Skill can then be defined as an organizational skill. If it is an organizational skill, it is managed by the organizational admins. If it is not an organizational skill, it is managed by its creator.
      A skill is made accessible to users based on the Skill Access grants.
      Additionally, a skill is schedulable, which means that a schedule can be defined by which the Skill is automatically run.
      ID: NUMBER: This is the Primary Key (Numeric) for AI Skills
      CEPHISSO_PLATFORM_ACCOUNTS_ID: NUMBER: This is the Sphere that this Skill exists in
      INPUT_VARIABLES: JSON: JSON array of any input variables that this skill needsEach element has three elements:1 Name2 Type3 Default Valueeg name:Contract Termtype:stringIndemnification ClauseThese are then completed by the user while initiating the skill
      NAME: VARCHAR2(255): This is the name of this Skill
      MACHINE_NAME: VARCHAR2(255): This is the Machine Name of the skill
      VERSION: NUMBER: This is a user-definable version number of the skill
      SHORT_DESCRIPTION: VARCHAR2(255): This is a short description of this skill This is used in helping detect the intent of a user to automatically infer the usage of a skill
      LONG_DESCRIPTION: CLOB: This is used for a long description of a skill This is used both for an end-users benefit as well as an intent router to help determine the right skill to be used
      ORGANIZATIONAL: NUMBER: This is used to track if the skill is managed at the organizational level If TRUE it is All other values mean it is managed by a user not the organization
      SYSTEM_GUID: VARCHAR2(36): This is used to track a unique identifier for a system specificaly a System GUID generated by SYSGUID()
      UUID: VARCHAR2(36): This is the UUID for this record
      METADATA: JSON: This is a JSON metadata field
      DATA_LINEAGE: JSON: This field includes any specifications about where the source system is any external identifier time last updated etc
      UDFS: JSON: This is used to track the UDFs (User Defined Fields) that might get added
      CREATED_ON: DATE: The Date-time that this record was created
      CREATED_BY: VARCHAR2(255): The User ID of the user account that created this record
      LAST_UPDATED_ON: DATE: This is the Date-time when this record was Last Updated
      LAST_UPDATED_BY: VARCHAR2(255): The User ID of the user account who last updated this record
      MESSAGE_TO_USER: CLOB:
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET '/ai-skills'
      Response Response Example
      {
          "items": [
              {
                  "cephisso_platform_accounts_id": 0,
                  "created_by": "string",
                  "created_on": "2019-08-24T14:15:22Z",
                  "data_lineage": null,
                  "id": 0,
                  "input_variables": null,
                  "last_updated_by": "string",
                  "last_updated_on": "2019-08-24T14:15:22Z",
                  "long_description": "string",
                  "machine_name": "string",
                  "message_to_user": "string",
                  "metadata": null,
                  "name": "string",
                  "organizational": 0,
                  "short_description": "string",
                  "skills_grouping_description": "string",
                  "skills_grouping_id": 0,
                  "skills_grouping_machine_name": "string",
                  "skills_grouping_title": "string",
                  "skill_grouping_order": 0,
                  "spheres_id": 0,
                  "system_guid": "string",
                  "udfs": null,
                  "uuid": "string",
                  "version": 0,
                  "visibility": "string"
              }
          ]
      }

      Request

      Authorization
      Provide your bearer token in the
      Authorization
      header when making requests to protected resources.
      Example:
      Authorization: Bearer ********************
      Header Params

      Responses

      🟢200OK
      application/json
      The queried record.
      Body

      Modified at 2025-07-25 16:11:31
      Previous
      /ai-skills
      Next
      /ai-skills/{id}
      Built with