Versori

https://docs.versori.com
Admin
Versori is a platform for building, deploying, and managing integrations, workflows, and agents that...
Tokens:262,503
Snippets:2,100
Trust Score:7.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install SDK with Yarn

Source: https://docs.versori.com/latest/run-sdk/latest/developers/overview

Use this command to install the Versori SDK via Yarn.

```bash
yarn add @versori/run
```

--------------------------------

### Create an API Key Connection (Example)

Source: https://docs.versori.com/latest/cli/connections

This example demonstrates creating a connection using an API key. If the required credentials are not provided, the CLI will prompt for them.

```bash
versori connections create --project 01KKBR46SH7JES8AZ14EEAK0CX --environment production --template-id 01KKBZ1ZB4SG2TRVKWQ7GNY3F3 --name demo-api-key --api-key supersecretdonotshare
```

--------------------------------

### Create an API Key Connection (Prompt Example)

Source: https://docs.versori.com/latest/cli/connections

This example shows the CLI prompting for a required 'api-key' when creating a connection if it's not provided in the command.

```bash
versori connections create --project 01KKBR46SH7JES8AZ14EEAK0CX --environment production --template-id 01KKBZ1ZB4SG2TRVKWQ7GNY3F3 --name demo-api-key
```

--------------------------------

### Install SDK with NPM

Source: https://docs.versori.com/latest/run-sdk/latest/developers/overview

Use this command to install the Versori SDK via NPM.

```bash
npm install @versori/run
```

--------------------------------

### Install SDK with Deno

Source: https://docs.versori.com/latest/run-sdk/latest/developers/overview

Use these commands to install the Versori SDK with Deno, either from JSR or NPM.

```bash
deno add jsr:@versori/run
```

```bash
# or if you really want to use NPM from deno...
deno add npm:@versori/run
```

--------------------------------

### Example: Update Connection Template to API Key

Source: https://docs.versori.com/latest/cli/connections

This example demonstrates updating a specific connection template to use an 'api-key' auth scheme instead of 'oauth2'. It shows the command and the expected output after verification.

```bash
versori projects systems update-connection-template --template 01KKBZ1ZB4SG2TRVKWQ7GNY3F3 --auth-scheme-config-id api-key --project 01KKBR46SH7JES8AZ14EEAK0CX
```

--------------------------------

### Install Versori CLI with Install Script

Source: https://docs.versori.com/latest/cli/installation

Use this command to automatically detect your OS and architecture, download the latest release binary, and place it in /usr/local/bin.

```bash
curl -fsSL https://raw.githubusercontent.com/versori/cli/main/install.sh | sh
```

--------------------------------

### Verify Versori CLI Installation

Source: https://docs.versori.com/latest/cli/installation

After installation, run this command to check if the Versori CLI is available and to display its version.

```bash
versori version
```

--------------------------------

### Register and Run Workflows with MemoryInterpreter

Source: https://docs.versori.com/latest/run-sdk

Register declared workflows (webhook and schedule) with a MemoryInterpreter and start the interpreter. This example assumes workflow1 and workflow2 are already defined.

```typescript
import { webhook, schedule, fn, MemoryInterpreter } from '@versori/run';

// Workflow 1 & 2 declarations...
// ...

async function main(): Promise<void> {
    const interpreter = await MemoryInterpreter.newInstance();

    interpreter.register(workflow1);
    interpreter.register(workflow2);

    await interpreter.start();
}

main().catch((err) => {
    console.error('Versori Run SDK Error', err);
});

```

--------------------------------

### Describe Integration Task in Claude Code

Source: https://docs.versori.com/latest/ai-tooling/installation

After installing the plugin, describe your integration task to Claude Code to initiate the workflow. The plugin will guide you through research, development, and deployment.

```bash
Build an integration that syncs new Shopify orders to QuickBooks as sales receipts.
```

--------------------------------

### Define a Webhook Trigger with a Task

Source: https://docs.versori.com/latest/run-sdk/latest/workflows

This example demonstrates creating a workflow that starts with a webhook trigger. It includes a task that uppercases the request body, with validation to ensure the body is a string.

```typescript
import { webhook, fn } from '@versori/run';

const workflow = webhook('upper-caser')
    .then(
        fn('upper-case', (ctx) => {
            if (typeof ctx.body !== 'string') {
                throw new Error('Body must be a string');
            }

            return ctx.body.toUpperCase();
        })
    );
```

--------------------------------

### Plan Agent Prompt Example

Source: https://docs.versori.com/latest/how-it-works/plan

Provide detailed information about systems, workflow triggers, actions, data mapping, edge cases, authentication, and documentation to ensure precise integration planning.

```text
I want to build an integration between Shopify and Quickbooks.

Whenever an order is created or updated, we receive individual webhook events, check if they already exist in Quickbooks via a GET, if the order does, update it and if not - create them.

Populate all API required fields to ensure the quickbooks api successfully creates Sales Orders.

Ensure to use oauth2 Authorization Code for Quickbooks, and API key for Shopify Access tokens.
```

--------------------------------

### List All Activations

Source: https://docs.versori.com/api-reference/platform-api/activations/list-activations

This example demonstrates how to list all activations using the platform API.

```APIDOC
## GET /activations

### Description
Retrieves a list of all activations.

### Method
GET

### Endpoint
/activations

### Query Parameters
- **limit** (integer) - Optional - The maximum number of activations to return.
- **offset** (integer) - Optional - The number of activations to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **activations** (array) - A list of activation objects.
  - **id** (string) - The unique identifier of the activation.
  - **name** (string) - The name of the activation.
  - **status** (string) - The current status of the activation (e.g., 'active', 'inactive', 'error').
  - **createdAt** (string) - The timestamp when the activation was created.

#### Response Example
{
  "activations": [
    {
      "id": "act_12345",
      "name": "My First Activation",
      "status": "active",
      "createdAt": "2023-10-27T10:00:00Z"
    }
  ]
}
```

--------------------------------

### Install Specific Version of Versori CLI

Source: https://docs.versori.com/latest/cli/installation

To pin to a specific version, set the VERSORI_VERSION environment variable before running the install script.

```bash
VERSORI_VERSION=v0.0.1 curl -fsSL https://raw.githubusercontent.com/versori/cli/main/install.sh | sh
```

--------------------------------

### Create a New System via CLI

Source: https://docs.versori.com/latest/cli/connections

Use this command to create a new system in your current organization. Replace placeholders with your specific details.

```bash
versori systems create --name <name> --domain <domain> --template-base-url <url>
```

--------------------------------

### Good Prompt Example for Integration

Source: https://docs.versori.com/latest/ai-tooling/tips

Use specific details about systems, triggers, field mappings, authentication, and edge cases for effective integration prompts.

```plaintext
Build an integration between HubSpot and Salesforce.
When a new contact is created in HubSpot (webhook), check if they exist in Salesforce by email.
If they exist, update the record. If not, create a new lead.
Use OAuth 2.0 for both systems.
Map: HubSpot firstname → Salesforce FirstName, HubSpot lastname → Salesforce LastName,
HubSpot email → Salesforce Email, HubSpot company → Salesforce Company.
```

--------------------------------

### Create System CLI Command

Source: https://docs.versori.com/latest/ai-tooling/workflow

Use this command to bootstrap systems on the Versori platform. It creates each system identified in the research phase and links them to your project.

```sh
versori systems create --name "Shopify" --base-url "https://my-store.myshopify.com"
```

--------------------------------

### Create System

Source: https://docs.versori.com/llms.txt

Creates a new system.

```APIDOC
## Create System

### Description
Creates a new system.

### Method
POST

### Endpoint
/systems

### Request Body
- **system_details** (object) - Required - The details of the new system.
```

--------------------------------

### Start Test Container

Source: https://docs.versori.com/api-reference/platform-api/projects/start-test-container

Starts a test container for the specified project. This container provides a temporary environment for testing and also exposes available triggers.

```APIDOC
## POST /o/{organisation_id}/projects/{project_id}/testing/start

### Description
Starts a test container for the project. The test container is a temporary environment that can be used to test the project. This endpoint will available triggers for the project.

### Method
POST

### Endpoint
/o/{organisation_id}/projects/{project_id}/testing/start

### Parameters
#### Path Parameters
- **organisation_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **containerRunning** (boolean) - Indicates if the test container is running.
- **triggers** (array) - A list of available project triggers.
  - **name** (string) - The name of the trigger/workflow.
  - **type** (string) - The type of the trigger (e.g., 'scheduler', 'webhook').
  - **cron_expr** (string) - Cron expression for scheduler type triggers (only applicable for scheduler type).
  - **method** (string) - HTTP method for the trigger.

#### Response Example
```json
{
  "containerRunning": true,
  "triggers": [
    {
      "name": "daily-report",
      "type": "scheduler",
      "cron_expr": "0 0 * * *",
      "method": "POST"
    }
  ]
}
```
```

--------------------------------

### Create a New Connection (General Command)

Source: https://docs.versori.com/latest/cli/connections

This is the general command structure for creating a new connection. You must provide project, environment, name, and template ID. Additional flags depend on the connection template's auth scheme.

```bash
versori connections create \
  --project <project-id> \
  --environment <environment-name> \
  --name <name> \
  --template-id <template-id> \
  [--api-key <value> | --bypass | etc...]
```

--------------------------------

### Verify Versori Plugin Installation in Claude Code

Source: https://docs.versori.com/latest/ai-tooling/installation

Run this command in Claude Code to list active plugins and confirm that `versori-skills@versori-cli` is installed and active.

```bash
/plugins
```

--------------------------------

### Install Versori Plugin in Claude Code

Source: https://docs.versori.com/latest/ai-tooling/installation

Use this command within Claude Code to install the Versori plugin. The plugin activates automatically for integration tasks.

```bash
/plugin install versori-skills@versori-cli
```

--------------------------------

### Add a System to a Project via CLI

Source: https://docs.versori.com/latest/cli/connections

Link a system to a project, which establishes a connection template. Ensure the provided name matches your code's expected system reference.

```bash
versori projects systems add \
  --project <project-id> \
  --system <system-id> \
  --name <name> \
  --environment <environment-name>
```

--------------------------------

### Get Slug Availability OpenAPI Specification

Source: https://docs.versori.com/api-reference/organisations-api/get-slug-availability

The OpenAPI specification for the Get Slug Availability endpoint. It defines the request parameters, responses, and schemas for slug availability checks.

```yaml
openapi: 3.1.0
info:
  title: Organisations API
  description: >-
    The Organisations API provides users the ability to manage their
    organisations.
  version: v1
servers:
  - url: https://platform.versori.com/api/organisations/v1
    description: Production server
  - url: http://localhost:8081/v1
    description: Localhost
security: []
tags:
  - name: organisations
    description: >
      Organisations is the root-level entity for the Versori platform. All
      resources are scoped under an Organisation,

      each Organisation has an owner and can have multiple members.
  - name: signing-keys
    description: >
      Signing keys are used to sign JWTs which can be used to authenticate
      requests to the Versori platform.
paths:
  /slug/{slug}/availability:
    get:
      summary: Get Slug Availability
      description: >
        GetSlugAvailability validates and returns whether the slug provided in
        the URL is available for use. Requests 

        to this endpoint are purposefully slow to mitigate automated enumeration
        of slugs.
      operationId: GetSlugAvailability
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlugAvailability'
default:
  description: Error
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/Error'
components:
  schemas:
    SlugAvailability:
      type: object
      properties:
        ok:
          description: >-
            OK is true if the slug is available for use, otherwise false and
            messages will be populated.
          type: boolean
        messages:
          description: >
            Messages is a list of user-friendly messages describing the
            problem(s) with this slug. This will always be

            an empty array if the slug is available.
          type: array
          items:
            type: string
      required:
        - ok
        - messages
    Error:
      type: object
      properties:
        code:
          type: string
          description: Code is a machine-readable error code.
        message:
          type: string
          description: Message is a human-readable error message.
        cause:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - code
        - message

```

--------------------------------

### Bootstrap systems from research context

Source: https://docs.versori.com/latest/cli/commands/projects/systems

Creates systems from a research context file. Requires a file path for the research context. System-specific overrides can be provided via a JSON object.

```sh
versori projects systems bootstrap --file <path> [flags]
```

--------------------------------

### Create a new Versori project

Source: https://docs.versori.com/latest/cli/workflow

Use this command to initialize a new project within Versori.

```sh
versori projects create --name my-project
```

--------------------------------

### OpenAPI Specification for Get Scheduler by ID

Source: https://docs.versori.com/api-reference/platform-api/schedulers/get-a-scheduler-by-id

This OpenAPI definition outlines the `GET` request for retrieving a scheduler by its ID. It specifies the endpoint, parameters, and expected responses, including success (200 OK) and error cases.

```yaml
openapi: 3.1.0
info:
  title: Versori Platform API
  version: 0.0.1
  license:
    name: UNLICENSED
servers:
  - description: Production
    url: https://platform.versori.com/api/v2
  - description: Staging
    url: https://platform-staging.versori.com/api/v2
  - description: Development
    url: http://localhost:8901
security:
  - bearerToken: []
  - cookie: []
paths:
  /o/{organisation_id}/environments/{environment_id}/schedulers/{scheduler_id}:
    parameters:
      - $ref: '#/components/parameters/organisation_id'
      - $ref: '#/components/parameters/environment_id'
      - $ref: '#/components/parameters/scheduler_id'
    get:
      tags:
        - schedulers
      summary: Get a Scheduler by ID
      description: |
        GetScheduler returns the Scheduler for the given scheduler ID.
      operationId: GetScheduler
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scheduler'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    organisation_id:
      name: organisation_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: OrganisationID
        x-go-type-import:
          path: versori.dev/vergo/ulid
    environment_id:
      name: environment_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: EnvironmentID
        x-go-type-import:
          path: versori.dev/vergo/ulid
    scheduler_id:
      name: scheduler_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: SchedulerID
        x-go-type-import:
          path: versori.dev/vergo/ulid
  schemas:
    Scheduler:
      type: object
      properties:
        id:
          type: string
          format: ulid
          x-go-type: ulid.ULID
          x-go-name: SchedulerID
          x-go-type-skip-optional-pointer: true
          x-go-type-import:
            path: versori.dev/vergo/ulid
        name:
          type: string
          description: The name of the scheduler.
        schedule:
          type: string
          description: The cron schedule for the scheduler.
        url:
          type: string
          format: uri
          description: The URL to which the scheduler will send requests.
        environment_id:
          type: string
          format: ulid
          x-go-type: ulid.ULID
          x-go-name: EnvironmentID
          x-go-type-skip-optional-pointer: true
          x-go-type-import:
            path: versori.dev/vergo/ulid
      required:
        - id
        - name
        - schedule
        - url
        - environment_id
    Error:
      type: object
      properties:
        code:
          type: string
          description: Code is a machine-readable error code.
        message:
          type: string
          description: Message is a human-readable error message.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
          x-go-type-skip-optional-pointer: true
        details:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - code
        - message
    ErrorField:
      description: ErrorField denotes a field which has an error.
      type: object
      properties:
        field:
          type: string
          description: >
            Field is the name of the field which has an error, this may be a
            path to a nested field, including array

            elements. The format of this field is of the form:
            "field1.field2[0].field3"
        message:
          type: string
          description: Message is the error message for this specific field.
      required:
        - field
        - message
  securitySchemes:
    bearerToken:
      description: >
        Bearer token authentication used by the Versori Platform. External
        consumers must provide an API key, however

        internal consumers must provide a JWT id_token issued by our IdP.
      type: http
      scheme: bearer
    cookie:
      description: Cookie authentication used by the Versori Platform.
      type: apiKey
      in: cookie
      name: cookie

```

--------------------------------

### OpenAPI Specification for Get Recording by ID

Source: https://docs.versori.com/api-reference/platform-api/automations/get-a-recording-by-id

This OpenAPI specification defines the `GET /o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}` endpoint. Use this to understand the request parameters and response structure for retrieving a recording.

```yaml
openapi: 3.1.0
info:
  title: Versori Platform API
  version: 0.0.1
  license:
    name: UNLICENSED
servers:
  - description: Production
    url: https://platform.versori.com/api/v2
  - description: Staging
    url: https://platform-staging.versori.com/api/v2
  - description: Development
    url: http://localhost:8901
security:
  - bearerToken: []
  - cookie: []
paths:
  /o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}:
    parameters:
      - $ref: '#/components/parameters/organisation_id'
      - $ref: '#/components/parameters/automation_id'
      - $ref: '#/components/parameters/recording_id'
    get:
      tags:
        - automations
      summary: Get a recording by ID
      description: |
        GetRecording returns the recording for the given recording ID.
      operationId: GetRecording
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationRecording'
components:
  parameters:
    organisation_id:
      name: organisation_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: OrganisationID
        x-go-type-import:
          path: versori.dev/vergo/ulid
    automation_id:
      name: automation_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: AutomationID
        x-go-type-import:
          path: versori.dev/vergo/ulid
    recording_id:
      name: recording_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: RecordingID
        x-go-type-import:
          path: versori.dev/vergo/ulid
  schemas:
    AutomationRecording:
      type: object
      properties:
        id:
          type: string
          format: ulid
          x-go-type: ulid.ULID
        transcription:
          type: string
        status:
          $ref: '#/components/schemas/AutomationJobStatus'
      required:
        - id
        - transcription
        - status
    AutomationJobStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
  securitySchemes:
    bearerToken:
      description: >
        Bearer token authentication used by the Versori Platform. External
        consumers must provide an API key, however

        internal consumers must provide a JWT id_token issued by our IdP.
      type: http
      scheme: bearer
    cookie:
      description: Cookie authentication used by the Versori Platform.
      type: apiKey
      in: cookie
      name: cookie

```

--------------------------------

### Connect to a system

Source: https://docs.versori.com/latest/cli/commands/projects/systems

Establishes a connection to a system within a project. You can specify either a connection ID or a template ID to connect to. The environment within the project must also be specified.

```sh
versori projects systems connect --project <project-id> --system <system-id> [flags]
```

--------------------------------

### Bootstrap systems from research context

Source: https://docs.versori.com/latest/cli/commands/projects/systems

Creates systems within a project based on provided research context.

```APIDOC
## versori projects systems bootstrap

### Description
Create systems from research context.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Flags
* `-f`, `--file`: Path to a file containing research context (required)
* `-h`, `--help`: help for bootstrap
* `--project`: Project ID; defaults from .versori when inside a synced project directory.
* `--system-overrides`: JSON object of per-system overrides (for example, `{"Stripe": {"base_url": "..."}}`)

### Request Example
```sh
versori projects systems bootstrap --file <path>
```

### Response
N/A
```

--------------------------------

### Get Organisation

Source: https://docs.versori.com/llms.txt

Retrieves an Organisation by its ID.

```APIDOC
## Get Organisation

### Description
Get an Organisation by its ID.

### Method
GET

### Endpoint
`/organisations/{organisationId}`

### Parameters
#### Path Parameters
- **organisationId** (string) - Required - The ID of the organisation to retrieve.

### Response
#### Success Response (200 OK)
- **id** (string) - The ID of the organisation.
- **name** (string) - The name of the organisation.
- **slug** (string) - The slug of the organisation.
```

--------------------------------

### OpenAPI Specification for Get Organisation Metrics Summary

Source: https://docs.versori.com/api-reference/platform-api/metrics/get-organisation-metrics-summary

This OpenAPI 3.1.0 specification defines the `GET /o/{organisation_id}/metricssummary` endpoint. It includes details on parameters, responses, and schemas for organization metrics and errors. Use this to understand the API contract.

```yaml
openapi: 3.1.0
info:
  title: Versori Platform API
  version: 0.0.1
  license:
    name: UNLICENSED
servers:
  - description: Production
    url: https://platform.versori.com/api/v2
  - description: Staging
    url: https://platform-staging.versori.com/api/v2
  - description: Development
    url: http://localhost:8901
security:
  - bearerToken: []
  - cookie: []
paths:
  /o/{organisation_id}/metricssummary:
    parameters:
      - $ref: '#/components/parameters/organisation_id'
    get:
      tags:
        - metrics
      summary: Get organisation metrics summary
      operationId: GetOrganisationMetricsSummary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganisationMetricsSummary'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    organisation_id:
      name: organisation_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: OrganisationID
        x-go-type-import:
          path: versori.dev/vergo/ulid
  schemas:
    OrganisationMetricsSummary:
      type: object
      properties:
        deployedProjects:
          $ref: '#/components/schemas/MetricSummary'
        totalExecutions:
          $ref: '#/components/schemas/MetricSummary'
        totalErrors:
          $ref: '#/components/schemas/MetricSummary'
      required:
        - deployedProjects
        - totalExecutions
        - totalErrors
    Error:
      type: object
      properties:
        code:
          type: string
          description: Code is a machine-readable error code.
        message:
          type: string
          description: Message is a human-readable error message.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
          x-go-type-skip-optional-pointer: true
        details:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - code
        - message
    MetricSummary:
      type: object
      properties:
        current:
          description: Current metric value
          type: number
          x-go-type: float64
          x-go-type-skip-optional-pointer: true
        past:
          description: Past metric value
          type: number
          x-go-type: float64
          x-go-type-skip-optional-pointer: true
      required:
        - current
    ErrorField:
      description: ErrorField denotes a field which has an error.
      type: object
      properties:
        field:
          type: string
          description: >
            Field is the name of the field which has an error, this may be a
            path to a nested field, including array

            elements. The format of this field is of the form:
            "field1.field2[0].field3"
        message:
          type: string
          description: Message is the error message for this specific field.
      required:
        - field
        - message
  securitySchemes:
    bearerToken:
      description: >
        Bearer token authentication used by the Versori Platform. External
        consumers must provide an API key, however

        internal consumers must provide a JWT id_token issued by our IdP.
      type: http
      scheme: bearer
    cookie:
      description: Cookie authentication used by the Versori Platform.
      type: apiKey
      in: cookie
      name: cookie

```

--------------------------------

### Connect to a system

Source: https://docs.versori.com/latest/cli/commands/projects/systems

Establishes a connection to a system within a project.

```APIDOC
## versori projects systems connect

### Description
Connect to a system.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Flags
* `--connection-id`: ID of the connection to connect to
* `--environment`: The environment name within the project
* `-h`, `--help`: help for connect
* `--project`: Project ID; defaults from .versori when inside a synced project directory.
* `--template-id`: ID of the connection template to connect to

### Request Example
```sh
versori projects systems connect --project <project-id> --system <system-id>
```

### Response
N/A
```

--------------------------------

### Get Project

Source: https://docs.versori.com/api-reference/platform-api/projects/get-project

Fetches the files and configuration for the specified project ID. Returns a 404 if the project does not exist.

```APIDOC
## Get Project

### Description
GetProject returns the files and configuration for the specified project ID. If one does not exist then a 404 will be returned.

### Method
GET

### Endpoint
/projects/{projectId}

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The ID of the project to retrieve.

#### Response
##### Success Response (200)
- **files** (object) - The files associated with the project.
- **configuration** (object) - The configuration settings for the project.

##### Error Response (404)
- **message** (string) - Indicates that the project was not found.
```

--------------------------------

### Get System by ID

Source: https://docs.versori.com/llms.txt

Retrieves a system by its ID.

```APIDOC
## Get System by ID

### Description
Retrieves a system by its ID.

### Method
GET

### Endpoint
/systems/{system_id}
```

--------------------------------

### Get Trace

Source: https://docs.versori.com/api-reference/platform-api/projects/get-trace

Retrieves an individual trace with all its spans.

```APIDOC
## Get Trace

### Description
GetTrace returns an individual trace with all the spans.

### Method
GET

### Endpoint
/projects/{{project_id}}/traces/{{trace_id}}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.
- **trace_id** (string) - Required - The ID of the trace to retrieve.

### Response
#### Success Response (200)
- **trace** (object) - The trace object containing spans.
  - **spans** (array) - An array of span objects.
    - **span_id** (string) - The ID of the span.
    - **operation_name** (string) - The name of the operation.
    - **start_time** (string) - The start time of the span (ISO 8601 format).
    - **end_time** (string) - The end time of the span (ISO 8601 format).
    - **attributes** (object) - Key-value pairs of attributes associated with the span.

#### Response Example
```json
{
  "trace": {
    "spans": [
      {
        "span_id": "span-123",
        "operation_name": "http.request",
        "start_time": "2023-10-27T10:00:00Z",
        "end_time": "2023-10-27T10:00:05Z",
        "attributes": {
          "http.method": "GET",
          "http.url": "/users/1"
        }
      }
    ]
  }
}
```
```

--------------------------------

### List static connections for a project environment

Source: https://docs.versori.com/latest/cli/commands/projects/systems

Retrieves a list of static connections for a specified project and environment. Requires the project ID and the environment name.

```sh
versori projects systems list-connections --project <project-id> --environment <environment-name> [flags]
```

--------------------------------

### Get Group

Source: https://docs.versori.com/api-reference/organisations-api/get-group

Retrieves a Group for the given Organisation.

```APIDOC
## Get Group

### Description
GetGroup returns a Group for the given Organisation.

### Method
GET

### Endpoint
/organisations/{organisationId}/groups/{groupId}
```

--------------------------------

### Create System

Source: https://docs.versori.com/latest/cli/commands/systems

Creates a new system within the current organization.

```APIDOC
## versori systems create

### Method
```sh
versori systems create --name <name> --domain <domain> --template-base-url <url> [flags]
```

### Parameters
#### Flags
* `--domain` (string) - Domain of the system.
* `-h`, `--help` - Help for create.
* `--name` (string) - Name of the system.
* `--template-base-url` (string) - Template base URL for the system.
```
Tokens:
Raw