Credo AI

Credo AI User API

Endpoints related to user preferences and settings

GitHub OpenAPI

Operations 11

GET /me/recently_visited_use_cases #
PATCH /me/setting/notification_preferences #
GET /me/setting #
GET /me #
PATCH /me #
PATCH /me/relationships/favorite_use_cases #
GET /me/teams #
GET /me/api_tokens #
POST /me/api_tokens #
GET /me/tasks #
DELETE /me/api_tokens/{id} #

Documentation

📖
Documentation
https://docs.sdk.credo.ai/docs/intro/
📖
APIReference
https://docs.sdk.credo.ai/docs/api-reference
📖
GettingStarted
https://docs.sdk.credo.ai/docs/getting-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/authentication/credo-ai-authentication.yml
📖
Documentation
https://api.credo.ai/openapi

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/openapi/credo-ai-user-api-openapi.yml

Other Resources

🔗
Swagger
https://api.credo.ai/swagger.json
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/conventions/credo-ai-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/errors/credo-ai-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/data-model/credo-ai-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/credo-ai-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

credo-ai-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Credo AI server API
  title: Credo AI server User API
servers:
- url: /api/v2/credoai
tags:
- name: user
  description: Endpoints related to user preferences and settings
paths:
  /me/recently_visited_use_cases:
    get:
      description: Retrieve a list of use cases that the user has recently interacted with.
      operationId: CredoAIWeb.API.V2.MeController.recently_visited_use_cases
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UseCasesResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
  /me/setting/notification_preferences:
    patch:
      description: Update the notification preferences for the currently authenticated user.
      operationId: CredoAIWeb.API.V2.UserController.update_my_noti_setting
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesRequest'
        description: data
  /me/setting:
    get:
      description: Retrieve the current settings for the authenticated user.
      operationId: CredoAIWeb.API.V2.UserController.show_my_setting
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UserSettingResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
  /me:
    get:
      description: Fetch the details of the currently authenticated user.
      operationId: CredoAIWeb.API.V2.MeController.show
      parameters:
      - description: 'Included relationships. Available options:

          - setting (preloads user settings)

          - favorite_use_cases (includes favorite use cases)

          - recently_visited_use_cases (DEPRECATED: use /me/recently_visited_use_cases endpoint instead)

          '
        in: query
        name: include
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MeResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
    patch:
      description: Update the profile information of the currently authenticated user.
      operationId: CredoAIWeb.API.V2.UserController.update_me
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ProfileUpdateRequest'
        description: data
  /me/relationships/favorite_use_cases:
    patch:
      description: Modify the list of the user's favorite use cases.
      operationId: CredoAIWeb.API.V2.MeController.set_favorite_use_cases
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MeResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/MeUpdateFavoriteUseCasesRequest'
        description: Attributes for updating the user's favorite use cases.
  /me/teams:
    get:
      description: Retrieve a list of teams that the currently authenticated user is a member of.
      operationId: CredoAIWeb.API.V2.TeamController.my_teams
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TeamsResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
  /me/api_tokens:
    get:
      description: Retrieve a list of API tokens associated with the authenticated user.
      operationId: CredoAIWeb.API.V2.ApiTokenController.index
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiTokensResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
    post:
      description: Generate a new API token for the authenticated user.
      operationId: CredoAIWeb.API.V2.ApiTokenController.create
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiTokenCreatedResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ApiTokenCreateRequest'
        description: The request body containing the details for the new API token.
  /me/tasks:
    get:
      description: Retrieve a list of tasks that are currently assigned to the authenticated user.
      operationId: CredoAIWeb.API.V2.TaskController.my_tasks
      parameters:
      - description: status match filter
        in: query
        name: filter[status]
        required: false
        x-example: in_progress
        schema:
          type: string
      - description: sort options
        in: query
        name: sort
        required: false
        x-example: -inserted_at,status
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TasksResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
  /me/api_tokens/{id}:
    delete:
      description: Remove the specified API token from the authenticated user's account.
      operationId: CredoAIWeb.API.V2.ApiTokenController.delete
      parameters:
      - description: The unique identifier of the API token to be deleted.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - user
components:
  schemas:
    TasksResponse:
      description: A collection of [TaskResource](#taskresource)
      properties:
        data:
          description: Content with [TaskResource](#taskresource) objects
          items:
            $ref: '#/components/schemas/TaskResource'
          type: array
      required:
      - data
      type: object
    UserResponse:
      description: A JSON-API document with a single [UserResource](#userresource) resource
      properties:
        data:
          $ref: '#/components/schemas/UserResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    NotificationPreferencesRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                type_email_enabled:
                  description: ''
                  type: boolean
                type_in_app_enabled:
                  description: ''
                  type: boolean
              type: object
            id:
              description: The JSON-API resource ID
              example: 64YUaLWSviHgibJaRWr3ZE
              type: string
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    TeamResource:
      description: ''
      properties:
        attributes:
          properties:
            description:
              description: ''
              type: string
            name:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            members:
              properties:
                data:
                  properties:
                    id:
                      description: Related members resource id
                      type: string
                    type:
                      description: Type of related members resource
                      type: string
                  type: object
              type: object
            memberships:
              properties:
                data:
                  items:
                    properties:
                      id:
                        description: Related memberships resource id
                        type: string
                      type:
                        description: Type of related memberships resource
                        type: string
                    type: object
                  type: array
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: teams
          type: string
      type: object
    UseCaseResource:
      description: ''
      properties:
        attributes:
          properties:
            monetary_value:
              description: ''
              type: string
            use_case_number:
              description: ''
              type: string
            risk_category_level:
              description: ''
              type: string
            creator_id:
              description: ''
              type: string
            risk_classification_set_at:
              description: ''
              type: string
            calculated_risk_score:
              description: ''
              type: string
            workflow_stage_id:
              description: ''
              type: string
            system_type:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            questionnaire_ids:
              description: ''
              type: string
            industries:
              description: ''
              type: string
            is_vendor:
              description: ''
              type: string
            entity_id:
              description: ''
              type: string
            configurable_risk_score_classification:
              description: ''
              type: string
            risk_score_calculated_at:
              description: ''
              type: string
            workflow_stage_step_status:
              description: ''
              type: string
            workflow_stage_step:
              description: ''
              type: string
            source:
              description: ''
              type: string
            control_refs:
              description: ''
              type: string
            risk_classification_id:
              description: ''
              type: string
            rai_issues_count:
              description: ''
              type: string
            policy_pack_refs:
              description: ''
              type: string
            risk_classification_set_by:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
            description:
              description: ''
              type: string
            name:
              description: ''
              type: string
            visible:
              description: ''
              type: string
            access_level:
              description: ''
              type: string
            risk_classification_set_by_user_id:
              description: ''
              type: string
            domain_ids:
              description: ''
              type: string
            settings:
              description: ''
              type: string
            alerts_count:
              description: ''
              type: string
            regions:
              description: ''
              type: string
            in_review:
              description: ''
              type: string
            icon:
              description: ''
              type: string
            ai_type:
              description: ''
              type: string
            risk_classification_level:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            alerts:
              properties:
                data:
                  properties:
                    id:
                      description: Related alerts resource id
                      type: string
                    type:
                      description: Type of related alerts resource
                      type: string
                  type: object
              type: object
            creator:
              properties:
                data:
                  properties:
                    id:
                      description: Related creator resource id
                      type: string
                    type:
                      description: Type of related creator resource
                      type: string
                  type: object
              type: object
            custom_fields:
              properties:
                data:
                  properties:
                    id:
                      description: Related custom_fields resource id
                      type: string
                    type:
                      description: Type of related custom_fields resource
                      type: string
                  type: object
              type: object
            desired_state:
              properties:
                data:
                  properties:
                    id:
                      description: Related desired_state resource id
                      type: string
                    type:
                      description: Type of related desired_state resource
                      type: string
                  type: object
              type: object
            domain_links:
              properties:
                data:
                  properties:
                    id:
                      description: Related domain_links resource id
                      type: string
                    type:
                      description: Type of related domain_links resource
                      type: string
                  type: object
              type: object
            domains:
              properties:
                data:
                  properties:
                    id:
                      description: Related domains resource id
                      type: string
                    type:
                      description: Type of related domains resource
                      type: string
                  type: object
              type: object
            governance_ai_contexts:
              properties:
                data:
                  properties:
                    id:
                      description: Related governance_ai_contexts resource id
                      type: string
                    type:
                      description: Type of related governance_ai_contexts resource
                      type: string
                  type: object
              type: object
            governance_ai_suggestions:
              properties:
                data:
                  properties:
                    id:
                      description: Related governance_ai_suggestions resource id
                      type: string
                    type:
                      description: Type of related governance_ai_suggestions resource
                      type: string
                  type: object
              type: object
            model_links:
              properties:
                data:
                  items:
                    properties:
                      id:
                        description: Related model_links resource id
                        type: string
                      type:
                        description: Type of related model_links resource
                        type: string
                    type: object
                  type: array
              type: object
            models:
              properties:
                data:
                  items:
                    properties:
                      id:
                        description: Related models resource id
                        type: string
                      type:
                        description: Type of related models resource
                        type: string
                    type: object
                  type: array
              type: object
            policy_packs:
              properties:
                data:
                  properties:
                    id:
                      description: Related policy_packs resource id
                      type: string
                    type:
                      description: Type of related policy_packs resource
                      type: string
                  type: object
              type: object
            questionnaires:
              properties:
                data:
                  properties:
                    id:
                      description: Related questionnaires resource id
                      type: string
                    type:
                      description: Type of related questionnaires resource
                      type: string
                  type: object
              type: object
            reviews:
              properties:
                data:
                  properties:
                    id:
                      description: Related reviews resource id
                      type: string
                    type:
                      description: Type of related reviews resource
                      type: string
                  type: object
              type: object
            risk_scenarios:
              properties:
                data:
                  properties:
                    id:
                      description: Related risk_scenarios resource id
                      type: string
                    type:
                      description: Type of related risk_scenarios resource
                      type: string
                  type: object
              type: object
            scheduled_reviews:
              properties:
                data:
                  properties:
                    id:
                      description: Related scheduled_reviews resource id
                      type: string
                    type:
                      description: Type of related scheduled_reviews resource
                      type: string
                  type: object
              type: object
            stakeholders:
              properties:
                data:
                  items:
                    properties:
                      id:
                        description: Related stakeholders resource id
                        type: string
                      type:
                        description: Type of related stakeholders resource
                        type: string
                    type: object
                  type: array
              type: object
            use_case_sync_issues:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case_sync_issues resource id
                      type: string
                    type:
                      description: Type of related use_case_sync_issues resource
                      type: string
                  type: object
              type: object
            vendor_links:
              properties:
                data:
                  properties:
                    id:
                      description: Related vendor_links resource id
                      type: string
                    type:
                      description: Type of related vendor_links resource
                      type: string
                  type: object
              type: object
            vendors:
              properties:
                data:
                  properties:
                    id:
                      description: Related vendors resource id
                      type: string
                    type:
                      description: Type of related vendors resource
                      type: string
                  type: object
              type: object
            workflow_stage:
              properties:
                data:
                  properties:
                    id:
                      description: Related workflow_stage resource id
                      type: string
                    type:
                      description: Type of related workflow_stage resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: use_cases
          type: string
      type: object
    UserSettingResponse:
      description: A JSON-API document with a single [UserSettingResource](#usersettingresource) resource
      properties:
        data:
          $ref: '#/components/schemas/UserSettingResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ApiTokenCreateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                name:
                  description: ''
                  type: string
              type: object
            id:
              description: The JSON-API resource ID
              example: 64YUaLWSviHgibJaRWr3ZE
              type: string
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ApiTokensResponse:
      description: A collection of [ApiTokenResource](#apitokenresource)
      properties:
        data:
          description: Content with [ApiTokenResource](#apitokenresource) objects
          items:
            $ref: '#/components/schemas/ApiTokenResource'
          type: array
      required:
      - data
      type: object
    ApiTokenResource:
      description: ''
      properties:
        attributes:
          properties:
            inserted_at:
              description: ''
              type: string
            last_used_at:
              description: ''
              type: string
            name:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties: {}
          type: object
        type:
          description: The JSON-API resource type
          example: api_tokens
          type: string
      type: object
    TaskResource:
      description: ''
      properties:
        attributes:
          properties:
            assigner_id:
              description: ''
              type: string
            completed_at:
              description: ''
              type: string
            due_date:
              description: ''
              type: string
            entity_questionnaire_section_id:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            status:
              description: ''
              type: string
            sub_status:
              description: ''
              type: string
            team_ids:
              description: ''
              type: string
            timezone:
              description: ''
              type: string
            type:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
            use_case_control_id:
              description: ''
              type: string
            use_case_id:
              description: ''
              type: string
            use_case_review_id:
              description: ''
              type: string
            user_ids:
              description: ''
              type: string
            vendor_id:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            assigner:
              properties:
                data:
                  properties:
                    id:
                      description: Related assigner resource id
                      type: string
                    type:
                      description: Type of related assigner resource
                      type: string
                  type: object
              type: object
            entity_questionnaire_section:
              properties:
                data:
                  properties:
                    id:
                      description: Related entity_questionnaire_section resource id
                      type: string
                    type:
                      description: Type of related entity_questionnaire_section resource
                      type: string
                  type: object
              type: object
            model:
              properties:
                data:
                  properties:
                    id:
                      description: Related model resource id
                      type: string
                    type:
                      description: Type of related model resource
                      type: string
                  type: object
              type: object
            teams:
              properties:
                data:
                  properties:
                    id:
                      description: Related teams resource id
                      type: string
                    type:
                      description: Type of related teams resource
                      type: string
                  type: object
              type: object
            use_case:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case resource id
                      type: string
                    type:
                      description: Type of related use_case resource
                      type: string
                  type: object
              type: object
            use_case_control:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case_control resource id
                      type: string
                    type:
                      description: Type of related use_case_control resource
                      type: string
                  type: object
              type: object
            use_case_review:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case_review resource id
                      type: string
                    type:
                      description: Type of related use_case_review resource
                      type: string
                  type: object
              type: object
            users:
              properties:
                data:
                  properties:
                    id:
                      description: Related users resource id
                      type: string
                    type:
                      description: Type of related users resource
                      type: string
                  type: object
              type: object
            vendor:
              properties:
                data:
                  properties:
                    id:
                      description: Related vendor resource id
                      type: string
                    type:
                      description: Type of related vendor resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: tasks
          type: string
      type: object

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/openapi/credo-ai-user-api-openapi.yml