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-skill-steps

      GET
      /ai-skill-steps
      Foundational GET all handler for: ai-skill-steps
      An AI Skill Step is used inside of a Skill.
      It can be one of a few options that are defined at the Global (Sphere=0) level:
      Single Shot - Meaning that it is a custom prompt that is given with an input from the user.
      HTTPS Call - Meaning that this will make an HTTPS call to a third party system, passing a variable for the headers and body that is configurable by the user.
      Skill ID - This Step will call another skill, passing all prior steps as input.
      Vector Query - This step will create a Vector Query on the FILES table based on the parameters selected. It requires a prompt and message to be set. It will additionally accept a model default and/or constraints.
      ID: NUMBER: This is the Primary Key (Numeric) for the AI Skill Step
      LLM_MODEL_DEPLOYMENTS_ID: NUMBER: This (optionally) mandates the LLM deployment that this skill step will use
      AI_SKILLS_ID: NUMBER:
      AI_SKILL_STEPS_ID: NUMBER: This is the Parent Skill Step if applicableThis is used in branching logic
      AI_SKILL_STEP_TYPES_ID: NUMBER: This represents the type of skill step that is being used
      STEP_ORDER: NUMBER: This is the numerical Order of the Skill Step
      MACHINE_NAME: VARCHAR2(255): This is the Machine Name of this AI Skill Step
      TITLE: VARCHAR2(255): This is the Title of this AI Skill Step
      DESCRIPTION: CLOB: This is a Description of the AI Skill Step
      SYSTEM_MESSAGE: CLOB: This is the SYSTEMMESSAGE that is sent to the LLM if this Skill Step involves a call to LLM
      USER_MESSAGE: CLOB: This is the User Message that is sent to the LLM if this step involves an LLM Call
      FILE_PARAMETER_FILTERS: JSON: JSON array of any file filter parameters for the Vector searchEach element should include:- Field name- Operator- Valueeg an array with elements: titleeqOperating Agreement
      HTTP_HEADERS: JSON: JSON Payload of the HTTP Headers to be set in making this call if an HTTPHTTPS Call
      HTTP_BODY: JSON: This is the HTTP Body that is sent in the request if of type HTTPHTTPS request
      URL: VARCHAR2(255): This is the HTTP URL for the Skill Step if of type HTTPHTTPS Request
      CEPHISSO_PLATFORM_ACCOUNTS_ID: NUMBER: This designates the Sphere that this Skill Step exists in
      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
      AI_SKILL_ID_TO_EXECUTE_ID: NUMBER: This field is used to indicate if there is a skill to execute as this skill stepThere is a skill Step Type w Machine Name SKILL that will drive the App Logic to determine if it looks at this or not

      Request

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

      Responses

      🟢200OK
      application/json
      The queried record.
      Body

      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET '/ai-skill-steps' \
      --header 'Authorization: Bearer <token>'
      Response Response Example
      {
          "items": [
              {
                  "ai_skills_id": 0,
                  "ai_skill_id_to_execute_id": 0,
                  "ai_skill_steps_id": 0,
                  "ai_skill_step_types_id": 0,
                  "cephisso_platform_accounts_id": 0,
                  "created_by": "string",
                  "created_on": "2019-08-24T14:15:22Z",
                  "data_lineage": null,
                  "description": "string",
                  "file_parameter_filters": null,
                  "http_body": null,
                  "http_headers": null,
                  "id": 0,
                  "last_updated_by": "string",
                  "last_updated_on": "2019-08-24T14:15:22Z",
                  "llm_model_deployments_id": 0,
                  "machine_name": "string",
                  "metadata": null,
                  "step_order": 0,
                  "system_guid": "string",
                  "system_message": "string",
                  "title": "string",
                  "udfs": null,
                  "url": "string",
                  "user_message": "string",
                  "uuid": "string"
              }
          ]
      }
      Modified at 2025-07-25 16:11:31
      Previous
      /ai-skill-steps
      Next
      /ai-skill-steps/{id}
      Built with