V7 Go

https://docs.go.v7labs.com
Admin
V7 Go is a platform for building and managing AI agents, offering comprehensive tools for agent...
Tokens:839,014
Snippets:3,627
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### List Entities in Library (cURL)

Source: https://docs.go.v7labs.com/reference/library

Example of how to list all entities in a v7labs library using a cURL request. This demonstrates the GET endpoint and necessary headers.

```shell
curl --request GET \
     --url https://go.v7labs.com/api/workspaces/workspace_id/library/entities \
     --header 'accept: application/json'
```

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

### POST /api/workspaces/{workspace_id}/imports/{import_id}/start

Source: https://docs.go.v7labs.com/reference/imports

Starts a new import process for an already uploaded import file. Requires workspace and import IDs.

```APIDOC
## POST /api/workspaces/{workspace_id}/imports/{import_id}/start

### Description
Starts a new import that already has the import file uploaded.

### Method
POST

### Endpoint
`https://go.v7labs.com/api/workspaces/{workspace_id}/imports/{import_id}/start`

### Parameters
#### Path Parameters
- **workspace_id** (uuid) - Required - The ID of the workspace.
- **import_id** (uuid) - Required - The ID of the import.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this endpoint."
}
```

### Response
#### Success Response (200)
- **created_at** (date-time) - DateTime in RFC3339 format.
- **error_details** (object | null) - Error details. When field has status `error`, this represents reason for that error. When field has status `complete`, this indicates that import wasn't processed in full due to error that got ignored (e.g. billing error when setting `billing_errors_as_warnings` is `true`).
- **code** (string) - Enum: `internal_server_error`, `system_limits_exceeded`, `billing_limits_exceeded`, `bad_request`, `invalid_import_file`.
- **message** (string | null) - Error message.
- **format** (string) - Enum: `csv`.
- **format_options** (object) - Specific options for the import format (e.g., `Imports.FormatOptionsCSV`).
- **id** (uuid) - The ID of the import.
- **processed_entities** (integer | null) - Number of entities processed.
- **project_exists** (boolean) - Indicates if the project already exists.
- **project_id** (uuid | null) - The ID of the project.
- **project_name** (string | null) - The name of the project.
- **settings** (object | null) - General, format independent settings for the import.
- **billing_errors_as_warnings** (boolean) - Defaults to true.
- **entity_limit** (integer | null) - The entity limit for the import.
- **status** (string) - Enum: `complete`, `error`, `processing`, `queued`, `pending`.
- **updated_at** (date-time) - DateTime in RFC3339 format.
- **workspace_id** (uuid) - The ID of the workspace.

#### Response Example
```json
{
  "created_at": "2023-10-27T10:00:00Z",
  "error_details": null,
  "code": null,
  "message": null,
  "format": "csv",
  "format_options": {
    "__class_name": "Imports.FormatOptionsCSV"
  },
  "id": "import-uuid-1234",
  "processed_entities": 100,
  "project_exists": true,
  "project_id": "project-uuid-5678",
  "project_name": "My Project",
  "settings": {
    "billing_errors_as_warnings": true,
    "entity_limit": null
  },
  "status": "processing",
  "updated_at": "2023-10-27T10:05:00Z",
  "workspace_id": "workspace-uuid-abcd"
}
```

#### Error Responses
- **400 Bad Request**: `Common.APIError`
- **401 Unauthorized**: `Common.APIError`
- **403 Forbidden**: `Common.APIError`
- **404 Not Found**: `Common.APIError`
- **409 Conflict**: `Common.APIError`
- **422 Unprocessable Entity**: `Common.APIError`
- **500 Internal Server Error**: `Common.APIError`
```

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

### List Entities in Library (Ruby)

Source: https://docs.go.v7labs.com/reference/library

Example of how to list all entities in a v7labs library using Ruby. This uses the built-in 'net/http' library for making the GET request.

```ruby
require 'uri'
require 'net/http'

url = URI("https://go.v7labs.com/api/workspaces/workspace_id/library/entities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"

response = http.request(request)
puts response.read_body
```

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

### List Entities in Library (PHP)

Source: https://docs.go.v7labs.com/reference/library

Example of how to list all entities in a v7labs library using PHP. This utilizes the cURL extension to perform the GET request.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.v7labs.com/api/workspaces/workspace_id/library/entities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

certification= curl_close($curl);

if ($err) {
  echo "cURL Error #" . $err;
} else {
  echo $response;
}

?>
```

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

### Create Global Skill Ruby Example

Source: https://docs.go.v7labs.com/reference/skills

Example of creating a global skill using Ruby. This code snippet demonstrates making an HTTP POST request to the skills API.

```Ruby
require 'uri'
require 'net/http'

url = URI("https://go.v7labs.com/api/skills")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.unparse({ type: 'code' })

response = http.request(request)
puts response.read_body
```

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

### List Entities in Library (Python)

Source: https://docs.go.v7labs.com/reference/library

Example of how to list all entities in a v7labs library using Python. This uses the 'requests' library for making the HTTP GET request.

```python
import requests

url = "https://go.v7labs.com/api/workspaces/workspace_id/library/entities"

headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.json())
```

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

### POST /websites/go_v7labs/files

Source: https://docs.go.v7labs.com/reference/entity-start-file-upload

Starts the file upload process for a specific project property and returns a URL to upload the file.

```APIDOC
## POST /websites/go_v7labs/files

### Description
This endpoint allows you to initiate a file upload for a specific project property. It returns a pre-signed URL where you can upload your file directly.

### Method
POST

### Endpoint
/websites/go_v7labs/files

### Parameters
#### Path Parameters
- **property_id_or_slug** (string) - Required - The unique identifier or slug of the project property.

#### Query Parameters
None

#### Request Body
- **filename** (string) - Required - The name of the file to be uploaded.
- **filesize** (integer) - Required - The size of the file in bytes.
- **content_type** (string) - Required - The MIME type of the file (e.g., 'image/jpeg').

### Request Example
```json
{
  "filename": "example.jpg",
  "filesize": 102400,
  "content_type": "image/jpeg"
}
```

### Response
#### Success Response (200)
- **upload_url** (string) - The pre-signed URL for uploading the file.
- **file_id** (string) - The unique identifier for the uploaded file.

#### Response Example
```json
{
  "upload_url": "https://your-storage-provider.com/upload?signature=...",
  "file_id": "f123abc456def"
}
```

#### Error Responses
- **400 Bad Request**: Invalid input parameters.
- **401 Unauthorized**: Authentication credentials are invalid.
- **403 Forbidden**: You do not have permission to perform this action.
- **404 Not Found**: The specified project property was not found.
- **409 Conflict**: A conflict occurred during the upload initiation.
- **422 Unprocessable Entity**: The request was well-formed but contains semantic errors.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

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

### Start Import with cURL

Source: https://docs.go.v7labs.com/reference/imports

Initiates a new import using cURL by sending a POST request to the V7 Labs API. Requires valid workspace_id and import_id as path parameters. Returns a 200 response with ImportResponse object containing import status and details.

```shell
curl --request POST \
     --url https://go.v7labs.com/api/workspaces/workspace_id/imports/import_id/start \
     --header 'accept: application/json'
```

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

### Create Global Skill PHP Example

Source: https://docs.go.v7labs.com/reference/skills

Example of creating a global skill using PHP. This code illustrates how to send a POST request to the skills API with JSON payload.

```PHP
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, "https://go.v7labs.com/api/skills");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_ENCODING, '');
curl_setopt($curl, CURLOPT_MAXREDIRS, 10);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
  'accept: application/json',
  'content-type: application/json'
));
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode(['type' => 'code']));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error # " . $err;
} else {
  echo $response;
}

?>
```

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

### Create Global Skill Python Example

Source: https://docs.go.v7labs.com/reference/skills

Example of creating a global skill using Python. This snippet demonstrates how to use the 'requests' library to make a POST request to the skills API.

```Python
import requests

url = "https://go.v7labs.com/api/skills"
headers = {
    'accept': 'application/json',
    'content-type': 'application/json'
}
data = {
    'type': 'code'
}

response = requests.post(url, headers=headers, json=data)

print(response.text)
```

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

### Create Global Skill Node.js Example

Source: https://docs.go.v7labs.com/reference/skills

Example of creating a global skill using Node.js. This snippet shows how to make a POST request to the skills API endpoint with appropriate headers and data.

```JavaScript
const options = {
  method: 'POST',
  url: 'https://go.v7labs.com/api/skills',
  headers: {
    'accept': 'application/json',
    'content-type': 'application/json'
  },
  body: { type: 'code' }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
```

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

### Accept Invitation - Node.js Example

Source: https://docs.go.v7labs.com/reference/projectinvitations

An example of accepting a V7 Labs project invitation using Node.js. This snippet would typically use a library like 'axios' or the built-in 'https' module to make the POST request with the required parameters.

```javascript
// Node.js example (implementation details would vary based on HTTP client library)
```

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

### POST /websites/go_v7labs/imports/prepare

Source: https://docs.go.v7labs.com/reference/import-prepare

Prepares an import process for an existing project. It allows specifying the import format, format-specific options, the target project ID, and general import settings.

```APIDOC
## POST /websites/go_v7labs/imports/prepare

### Description
Prepares an import process for an existing project. This endpoint allows you to configure the import settings, including the file format, format-specific options, the project to import into, and general import preferences.

### Method
POST

### Endpoint
/websites/go_v7labs/imports/prepare

### Parameters
#### Request Body
- **format** (Imports.Format) - Required - The format of the import file (e.g., 'csv').
- **format_options** (Imports.FormatOptions) - Required - Options specific to the chosen import format.
- **project_id** (Common.UUID) - Required - The unique identifier of the existing project to import into.
- **settings** (Imports.Settings) - Optional - General settings for the import process.

### Request Example
```json
{
  "format": "csv",
  "format_options": {
    "delimiter": ",",
    "quote_char": "\""
  },
  "project_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "settings": {
    "billing_errors_as_warnings": true,
    "entity_limit": 1000
  }
}
```

### Response
#### Success Response (200)
- **import_id** (Common.UUID) - The unique identifier for the prepared import.
- **status** (string) - The initial status of the import preparation (e.g., 'pending').

#### Response Example
```json
{
  "import_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "pending"
}
```

#### Error Response (400, 404, 500)
- **code** (string) - An error code indicating the type of error (e.g., 'bad_request', 'invalid_import_file').
- **message** (string) - A human-readable message describing the error.

#### Error Response Example
```json
{
  "code": "bad_request",
  "message": "Invalid file format specified."
}
```
```

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

### POST /api/workspaces/{workspace_id}/integrations/{integration_id}/connections/{connection_id}/start

Source: https://docs.go.v7labs.com/reference/integration-connection-start-legacy

Initiates syncing via the Integrator for a specific connection. This is a legacy endpoint and may be deprecated.

```APIDOC
## POST /api/workspaces/{workspace_id}/integrations/{integration_id}/connections/{connection_id}/start

### Description
Initiates syncing via the Integrator for the connection.

### Method
POST

### Endpoint
/api/workspaces/{workspace_id}/integrations/{integration_id}/connections/{connection_id}/start

### Parameters
#### Path Parameters
- **workspace_id** (Common.UUID) - Required - The ID of the workspace.
- **integration_id** (Integrations.IntegrationId) - Required - The type of the integration that Go supports.
- **connection_id** (Common.UUID) - Required - The ID of the connection.

#### Query Parameters
None

#### Request Body
- **Integrations.ConnectionStartSettings** (object) - Required - Settings for starting the connection.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **Integrations.NotStartedConnectionResponse** (object) - Details about the connection that has not started.

#### Error Response (400)
- **Common.APIError** (object) - Standard API error response.

#### Error Response (401)
- **Common.APIError** (object) - Authentication error response.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### List aggregated field errors (Python)

Source: https://docs.go.v7labs.com/reference/workspaces

Example Python request to list aggregated field errors. This code uses the 'requests' library to make a GET request to the v7labs API.

```python
import requests

url = "https://go.v7labs.com/api/workspaces/workspace_id/field_errors"

headers = {
    'accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### List aggregated field errors (PHP)

Source: https://docs.go.v7labs.com/reference/workspaces

Example PHP request to list aggregated field errors. This snippet shows how to send a GET request to the v7labs API endpoint for field errors.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, "https://go.v7labs.com/api/workspaces/workspace_id/field_errors");
curl_setopt($curl, CURLOPT_HTTPHEADER, [
  'accept: application/json',
]);

$response = curl_exec($curl);

if (curl_errno($curl)) {
    echo 'Error:' . curl_error($curl);
}

curl_close($curl);

var_dump($response);

?>
```

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

### POST /api/workspaces/{workspace_id}/integrations/{integration_id}/connections/{connection_id}/start_file_picker_session

Source: https://docs.go.v7labs.com/reference/integration-connection-start-file-picker-session

Starts a file picker session for the given connection. Returns all data required to open an integration-specific file picker.

```APIDOC
## POST /api/workspaces/{workspace_id}/integrations/{integration_id}/connections/{connection_id}/start_file_picker_session

### Description
Starts a file picker session for the given connection. Returns all data required to open an integration-specific file picker.

### Method
POST

### Endpoint
/api/workspaces/{workspace_id}/integrations/{integration_id}/connections/{connection_id}/start_file_picker_session

### Parameters
#### Path Parameters
- **workspace_id** (Common.UUID) - Required - 
- **integration_id** (Integrations.IntegrationId) - Required - The type of the integration that Go supports.
- **connection_id** (Common.UUID) - Required - 

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **access_token** (string) - Access token to use for 3rd party file picker session
- **expires_at** (string) - Expiration date-time of the access token (ISO 8601)
- **type** (string) - Type of the access token (enum: "oauth2")

#### Response Example
```json
{
  "access_token": "ya29.a0AR5s-...},
  "type": "oauth2",
  "expires_at": "2024-05-15T10:00:00Z"
}
```

#### Error Response
- **code** (string) - Error code
- **message** (string) - Error message

#### Error Response Example
```json
{
  "code": "bad_request",
  "message": "Bad Request"
}
```
```

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

### List Integration Connections (PHP)

Source: https://docs.go.v7labs.com/reference/integrationconnections

PHP script to fetch integration connections. This example uses Guzzle HTTP client to make a GET request to the v7labs API, allowing for the `workspace_id` and `include_public` parameter.

```PHP
<?php

require 'vendor/autoload.php'; // Assuming you use Composer

use GuzzleHttp\Client;

function listConnections(string $workspaceId, bool $includePublic = false)
{
    $client = new Client();
    $url = "https://go.v7labs.com/api/workspaces/{$workspaceId}/integrations/all/connections";
    
    $response = $client->request('GET', $url, [
        'headers' => [
            'accept' => 'application/json'
        ],
        'query' => [
            'include_public' => $includePublic
        ]
    ]);

    return json_decode($response->getBody(), true);
}

?>
```

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

### Create Entity Request Examples

Source: https://docs.go.v7labs.com/reference/entity-create

Demonstrates how to structure requests for creating an entity. Includes an empty request and a request with text fields. The endpoint supports waiting for property calculations before returning, with a 45-second timeout.

```json
{
  "fields": {
    "field1": "value1",
    "field2": "value2"
  }
}
```

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

### List Integration Connections (Python)

Source: https://docs.go.v7labs.com/reference/integrationconnections

Python code to retrieve a list of integration connections. This example uses the `requests` library to send a GET request to the v7labs API, with placeholders for `workspace_id` and the `include_public` option.

```Python
import requests

def list_connections(workspace_id, include_public=False):
    url = f"https://go.v7labs.com/api/workspaces/{workspace_id}/integrations/all/connections"
    headers = {
        'accept': 'application/json'
    }
    params = {
        'include_public': include_public
    }
    response = requests.get(url, headers=headers, params=params)
    response.raise_for_status()  # Raise an exception for bad status codes
    return response.json()
```

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

### POST /websites/go_v7labs/case-initiate-file-upload

Source: https://docs.go.v7labs.com/reference/case-start-file-upload

Initiates the file upload process for a specified case and returns a URL for uploading the file. After successful upload, use the confirm endpoint.

```APIDOC
## POST /websites/go_v7labs/case-initiate-file-upload

### Description
Starts the file upload process for a given Case. Use the retrieved `file_upload_url` to upload the file to the storage. After the file is uploaded, use `case-confirm-files-upload` to confirm the upload.

### Method
POST

### Endpoint
/websites/go_v7labs/case-initiate-file-upload

### Parameters
#### Query Parameters
- **case_id** (string) - Required - The ID of the case for which to initiate the file upload.

### Request Example
```json
{
  "case_id": "case_12345"
}
```

### Response
#### Success Response (200)
- **file_upload_url** (string) - The URL to which the file should be uploaded.
- **upload_id** (string) - A unique identifier for this upload process.

#### Response Example
```json
{
  "file_upload_url": "https://storage.example.com/upload/path/to/file",
  "upload_id": "upload_abcde"
}
```
```

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

### GET /api/workspaces/{workspace_id}/billing/plans

Source: https://docs.go.v7labs.com/reference/billing-plan-list

Returns details of all plans in a given Workspace, including effective plan (currently active), incomplete plans (e.g., started upgrades), and available plans for upgrade. Usage information is only returned for the effective plan and workspace-scoped limits.

```APIDOC
## GET /api/workspaces/{workspace_id}/billing/plans

### Description
Retrieve billing plan details for a workspace, including effective, incomplete, and available plans with usage information and limits.

### Method
GET

### Endpoint
`/api/workspaces/{workspace_id}/billing/plans`

### Parameters
#### Path Parameters
- **workspace_id** (UUID) - Required - The unique identifier of the workspace

### Response
#### Success Response (200)
- **Billing.ListPlansResponse** (object) - Contains lists of effective plans, incomplete plans, and available plans with usage limits

#### Response Schema
**Billing.PlanTemplate** (object)
- **name** (string) - Required - Name of the plan
- **provider** (string) - Required - Provider of the plan
- **billing_period** (string) - Required - Billing period: "yearly" or "monthly"
- **tier_order** (integer) - Required - Order of tier
- **limits** (array) - Required - Array of usage limits

**Billing.UsageLimit** (object)
- **name** (string) - Required - Name of the limit
- **scope** (string) - Required - Scope of the limit
- **aggregation** (string) - Required - Aggregation method for the limit
- **type** (string) - Required - Type of the limit
- **limit_value** (integer | string) - Required - The limit value (integer or "unlimited")

**Billing.PlanBillingPeriod** (enum)
- Possible values: "yearly", "monthly"

#### Error Response (400)
- **Common.APIError** (object) - Error details

### Authentication
- **ApiKeyAuth** - Header: `X-API-KEY`
- **BearerAuth** - HTTP Bearer token

### Example Request
```
GET /api/workspaces/e23ff3f3-8f77-4e78-9e81-fdb25abfb781/billing/plans
X-API-KEY: your-api-key
```

### Example Response (200)
```json
{
  "effective_plan": {
    "name": "Professional",
    "provider": "stripe",
    "billing_period": "monthly",
    "tier_order": 2,
    "limits": [
      {
        "name": "api_calls",
        "scope": "workspace",
        "aggregation": "sum",
        "type": "rate",
        "limit_value": 100000
      },
      {
        "name": "storage",
        "scope": "workspace",
        "aggregation": "sum",
        "type": "quota",
        "limit_value": "unlimited"
      }
    ]
  },
  "incomplete_plans": [],
  "available_plans": [
    {
      "name": "Enterprise",
      "provider": "stripe",
      "billing_period": "yearly",
      "tier_order": 3,
      "limits": []
    }
  ]
}
```
```

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

### List aggregated field errors (Ruby)

Source: https://docs.go.v7labs.com/reference/workspaces

Example Ruby request to list aggregated field errors. This code demonstrates how to make a GET request to the v7labs API to retrieve grouped field errors.

```ruby
require 'uri'
require 'net/http'

url = URI("https://go.v7labs.com/api/workspaces/workspace_id/field_errors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"

response = http.request(request)
puts response.read_body
```

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

### List Integration Connections (Node.js)

Source: https://docs.go.v7labs.com/reference/integrationconnections

Example of listing integration connections using Node.js. This snippet utilizes the `axios` library to make a GET request to the v7labs API, requiring the `workspace_id` and an optional `include_public` parameter.

```JavaScript
const axios = require('axios');

async function listConnections(workspaceId, includePublic = false) {
  try {
    const response = await axios.get(`https://go.v7labs.com/api/workspaces/${workspaceId}/integrations/all/connections`, {
      params: {
        include_public: includePublic
      },
      headers: {
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error listing connections:', error);
    throw error;
  }
}
```

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

### Projects.HubSelectPropertyConfigResponse

Source: https://docs.go.v7labs.com/reference/project-create

Configuration for a hub select property.

```APIDOC
## Projects.HubSelectPropertyConfigResponse

### Description
Configuration for a hub select property, defining options, maximum selections, and default selection.

### Method
Not applicable (Data Model Definition)

### Endpoint
Not applicable (Data Model Definition)

### Parameters
#### Request Body
- **max_selected** (object) - Required - Defines the maximum number of selections allowed.
- **options** (array) - Required - A list of available options for the select property.
  - **items** (object) - An option within the select property.
- **default_option** (object) - Required - The default selected option.
- **dynamic_options** (boolean) - Required - Indicates whether options are dynamically loaded from all workspace hubs.

### Request Example
```json
{
  "max_selected": { ... },
  "options": [
    { ... },
    { ... }
  ],
  "default_option": { ... },
  "dynamic_options": true
}
```

### Response
#### Success Response (200)
- **//**: This is a schema definition, not a direct API response.

#### Response Example
```json
{
  "//": "Example response structure for Projects.HubSelectPropertyConfigResponse"
}
```
```

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

### Project Property Configurations

Source: https://docs.go.v7labs.com/reference/project-list-properties

Documentation for project property configurations, including single-select and multi-select property types.

```APIDOC
## Project Property Configurations

### Projects.SingleSelectPropertyConfigResponse

Represents the configuration for a single-select property within a project.

- **options**: (array of Projects.SelectOptionResponse) The available options for the select property.
- **default_option**: (Projects.SelectDefaultOption) The default selected option.

### Projects.MultiSelectPropertyConfigResponse

Represents the configuration for a multi-select property within a project.

- **options**: (array of Projects.SelectOptionResponse) The available options for the select property.
- **max_selected**: (Projects.SelectMaxSelected) The maximum number of options that can be selected.
- **default_option**: (Projects.SelectDefaultOption) The default selected option.
```

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

### List SSO Connections for a Workspace (Node.js)

Source: https://docs.go.v7labs.com/reference/auth0ssoconnection

This Node.js snippet shows how to fetch SSO connections for a workspace via the v1.0 API. It utilizes the 'axios' library to make the GET request and handles the JSON response. Ensure 'axios' is installed.

```JavaScript
const axios = require('axios');

const listSSOConnections = async (workspaceId) => {
  try {
    const response = await axios.get(`https://go.v7labs.com/api/workspaces/${workspaceId}/sso_connections`, {
      headers: {
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error listing SSO connections:', error);
    throw error;
  }
};

// Example usage:
// listSSOConnections('your_workspace_id').then(data => console.log(data));
```

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

### Basic Prompt Structure: Role, Task, Format (JavaScript)

Source: https://docs.go.v7labs.com/docs/section-5-prompting-fundamentals

This example demonstrates the fundamental 'Role → Task → Format' prompt structure. It defines the AI's persona, the specific action to perform, and the desired output format. This is typically used for straightforward extraction tasks.

```javascript
You are a real estate analyst.
Extract the net lease amount from the provided agreement.
Return only the numeric value in plain text, without currency symbols or commas.
```

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

### List SSO Connections for a Workspace (Python)

Source: https://docs.go.v7labs.com/reference/auth0ssoconnection

This Python snippet utilizes the 'requests' library to list SSO connections for a workspace. It sends a GET request to the API endpoint, including the workspace ID and the 'accept' header for JSON format. Ensure 'requests' is installed.

```Python
import requests

def list_sso_connections(workspace_id):
    url = f"https://go.v7labs.com/api/workspaces/{workspace_id}/sso_connections"
    headers = {
        "accept": "application/json"
    }
    
    try:
        response = requests.get(url, headers=headers)
        response.raise_for_status()  # Raise an exception for bad status codes
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error listing SSO connections: {e}")
        return None

# Example usage:
# workspace_id = 'your_workspace_id'
# connections = list_sso_connections(workspace_id)
# if connections:
#     print(connections)
```

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

### Get Logged-in User API Endpoint

Source: https://docs.go.v7labs.com/reference/user-get-me

Defines the GET endpoint for retrieving details of the currently logged-in user. It returns a Users.UserMeResponse on success or a Common.APIError for specific error conditions.

```json
{
  "/api/users/me": {
    "get": {
      "description": "Returns details of a logged in user",
      "operationId": "user-get-me",
      "parameters": [],
      "responses": {
        "200": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Users.UserMeResponse"
              }
            }
          },
          "description": "Users.UserMeResponse"
        },
        "400": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Common.APIError"
              }
            }
          },
          "description": "Common.APIError"
        },
        "401": {
          "content": {}
        }
      }
    }
  }
}
```

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

### Start File Picker Session

Source: https://docs.go.v7labs.com/reference/integration-connection-start-file-picker-session

Initiates a new session for the file picker, allowing users to select files from integrated services.

```APIDOC
## POST /integrations/file-picker/session

### Description
Starts a file picker session.

### Method
POST

### Endpoint
/integrations/file-picker/session

### Parameters
#### Query Parameters

#### Request Body
(No request body defined for this endpoint)

### Request Example
(No request example provided)

### Response
#### Success Response (200)
- **response** (object) - The response from starting a file picker session. Refers to `Integrations.StartFilePickerSessionResponse` schema.

#### Response Example
```json
{
  "sessionId": "string",
  "url": "string"
}
```

#### Error Responses
- **400, 401, 403, 404, 409, 422, 500** - Returns a `Common.APIError` object.
```

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

### GET /api/workspaces/{workspace_id}/projects/{project_id}/exports/{export_id}

Source: https://docs.go.v7labs.com/reference/export-get

Retrieves the details of a specific export. This endpoint allows you to get information about a particular export job within a project and workspace.

```APIDOC
## GET /api/workspaces/{workspace_id}/projects/{project_id}/exports/{export_id}

### Description
Returns details of a single export.

### Method
GET

### Endpoint
/api/workspaces/{workspace_id}/projects/{project_id}/exports/{export_id}

### Parameters
#### Path Parameters
- **workspace_id** (string, uuid) - Required - The ID of the workspace.
- **project_id** (string, uuid) - Required - The ID of the project.
- **export_id** (string, uuid) - Required - The ID of the export.

### Response
#### Success Response (200)
- **id** (string, uuid) - The unique identifier for the export.
- **project_id** (string, uuid) - The ID of the project associated with the export.
- **name** (string) - The name of the export.
- **url** (string, nullable) - The URL to access the exported data, if available.
- **status** (string) - The current status of the export (e.g., pending, complete, error).
- **inserted_at** (string, date-time) - The timestamp when the export was created.
- **updated_at** (string, date-time) - The timestamp when the export was last updated.
- **format** (string) - The format of the export (e.g., csv, xlsx).

#### Response Example (200)
```json
{
  "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "project_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "my_export",
  "url": "https://example.com/exports/my_export.csv",
  "status": "complete",
  "inserted_at": "2020-01-20T14:00:00Z",
  "updated_at": "2020-01-20T14:05:00Z",
  "format": "csv"
}
```

#### Error Response (400)
- **code** (string) - An error code (e.g., "bad_request").
- **message** (string) - A human-readable error message.

#### Response Example (400)
```json
{
  "code": "bad_request",
  "message": "Invalid request parameters."
}
```
```

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

### Property Response

Source: https://docs.go.v7labs.com/reference/project-clone

Retrieve property information including configuration, description with reference support, effective tool designation, and enabled skills. Properties support input and hub references in description fields using @<reference_as> format patterns.

```APIDOC
## Property Response

### Description
A property schema containing configuration, description with reference support, tool information, and skill enablement settings. Property descriptions can contain input references (@<P...>) and hub references (@<H...>).

### Schema
**Name:** Projects.PropertyResponse

**Type:** object

### Properties
- **config** (Projects.PropertyConfigResponse) - Required - Property configuration settings
- **description** (string) - Optional - Property description. Supports input and hub references:
  - Input References: `@<P<property_id>>`, `@<P<property_id>:E<entity_id>>`, `@<P<property_id>:T<input_target>>`, `@<P<property_id>:E<entity_id>:T<input_target>>`
  - Hub References: `@<H<hub_id>>` for static hubs, or property reference for hub select properties
- **effective_tool** (string) - Deprecated - Always set to `tool`
- **enabled_skills** (array) - Optional - List of skills enabled for this property (non-manual properties only). Default: []

### Reference Pattern Examples
- `@<P01h8v4k3-9f2a-4b5c-8e7d-1a2b3c4d5e6f>` - Reference to property value
- `@<P01h8v4k3-9f2a-4b5c-8e7d-1a2b3c4d5e6f:E01i9w5n4-0g3b-5c6d-9f8e-2b3c4d5e6f7g>` - Reference to library property value
- `@<P01h8v4k3-9f2a-4b5c-8e7d-1a2b3c4d5e6f:Ttool_metadata.motivation>` - Reference to property metadata
- `@<H01h8v4k3-9f2a-4b5c-8e7d-1a2b3c4d5e6f>` - Direct reference to a static hub

### Request Example
{
  "config": {},
  "description": "Property description with @<P01h8v4k3-9f2a-4b5c-8e7d-1a2b3c4d5e6f> reference",
  "enabled_skills": []
}

### Response Example
{
  "config": {},
  "description": "Property with input and hub references",
  "effective_tool": "tool",
  "enabled_skills": ["skill1", "skill2"]
}
```

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

### Advanced Prompt Structure: Reasoning (JSON Configuration)

Source: https://docs.go.v7labs.com/docs/section-5-prompting-fundamentals

This configuration showcases a more complex prompt structure designed for tasks requiring step-by-step reasoning. It includes role, objective, context, detailed steps for the AI to follow, and a specific JSON output format. This is suitable for intricate analysis and data extraction where intermediate logic is needed.

```json
{
  "data": {
    "h-0": "Component",
    "h-1": "Purpose",
    "h-2": "Example",
    "0-0": "Role",
    "0-1": "Tell the model _who it is_",
    "0-2": "You are a senior tax compliance analyst specializing in corporate reporting and regulatory audit preparation.",
    "1-0": "Objective",
    "1-1": "Tell the model what it’s trying to do.",
    "1-2": "Your task is to extract the following compliance-critical data points from the uploaded document:  \n  \n- Total Taxable Income\n- Jurisdiction(s) Reported\n- Deferred Tax Assets\n- Effective Tax Rate\n- Schedule M-3 Adjustments (if any)",
    "2-0": "Context",
    "2-1": "Provide the prompt context around what you’re trying to solve.",
    "2-2": "Steps",
    "3-0": "Steps",
    "3-1": "Specify exactly how the LLM should think through this problem, step by step.",
    "3-2": "First, identify and isolate the relevant sections of the document where each value is discussed or reported.  \n  \nNext, for each field:  \n  \n1. Look for the numeric value or jurisdiction text associated with the field name (e.g., \"Total Taxable Income\").\n2. If the field is not explicitly labeled, infer it from related language (e.g., \"Pre-tax earnings adjusted for deferred items\").\n3. Validate your findings using any associated form references (e.g., Schedule M-3 or Part III).\n4. If a field is not present in the document, return` \"value\": null`.",
    "4-0": "Output Format",
    "4-1": "Specify exactly how the result should appear",
    "4-2": "Return your result as a JSON object using the following format:  \n  \n{\n\"total_taxable_income\": \"float or null\",  \n\"jurisdictions_reported\": [\"list of strings or null\"]  \n\"deferred_tax_assets\": \"float or null\",  \n\"effective_tax_rate\": \"percentage as float or null\",  \n\"schedule_m3_adjustments\": [\"list of string explanations or null\"]  \n}"
  },
  "cols": 3,
  "rows": 5,
  "align": [
    null,
    null,
    null
  ]
}
```

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

### POST /websites/go_v7labs/projects

Source: https://docs.go.v7labs.com/reference/library-get-workspace

Creates a new project. This endpoint allows for the creation of new project entries within the system.

```APIDOC
## POST /websites/go_v7labs/projects

### Description
Creates a new project. This endpoint allows for the creation of new project entries within the system.

### Method
POST

### Endpoint
/websites/go_v7labs/projects

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new project.
- **description** (string) - Optional - A description for the new project.
- **workspace_id** (UUID) - Required - The ID of the workspace to which the project belongs.
- **type** (ProjectType) - Required - The type of the project.
- **properties** (array) - Optional - An array of initial properties for the project.
- **parent_folder_id** (UUID) - Optional - The ID of the parent folder for the project.

### Request Example
```json
{
  "name": "New Project",
  "description": "Creating a new project via API.",
  "workspace_id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "type": "standard",
  "properties": [],
  "parent_folder_id": null
}
```

### Response
#### Success Response (201)
- **id** (UUID) - The unique identifier for the newly created project.
- **name** (string) - The name of the project.
- **description** (string) - A description of the project.
- **workspace_id** (UUID) - The identifier of the workspace the project belongs to.
- **properties** (array) - A list of properties associated with the project.
- **parent_property** (object) - Information about the parent property of the project.
- **parent_folder_id** (UUID) - The identifier of the parent folder.
- **cover_image_urls** (object) - URLs for the project's cover images.
- **views** (array) - A list of views associated with the project.
- **main_view_id** (UUID) - The identifier of the main view.
- **auto_recalculations** (boolean) - Indicates if auto-recalculations are enabled.
- **updated_at** (DateTime) - The timestamp when the project was last updated.
- **created_at** (DateTime) - The timestamp when the project was created.
- **type** (ProjectType) - The type of the project.

#### Response Example
```json
{
  "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef12",
  "name": "New Project",
  "description": "Creating a new project via API.",
  "workspace_id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "properties": [],
  "parent_property": null,
  "parent_folder_id": null,
  "cover_image_urls": {},
  "views": [],
  "main_view_id": null,
  "auto_recalculations": false,
  "updated_at": "2023-10-27T11:00:00Z",
  "created_at": "2023-10-27T11:00:00Z",
  "type": "standard"
}
```
```

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

### Define Not Started Connection Response Schema (OpenAPI)

Source: https://docs.go.v7labs.com/reference/integration-connection-confirm-legacy

Defines the response schema for a connection that has not yet started. It includes fields like id, status, user_id, integration_id, workspace_id, provider, public, and local_metadata, with references to other schemas.

```json
{
  "additionalProperties": false,
  "description": "A not started connection.",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Common.UUID"
    },
    "integration_id": {
      "$ref": "#/components/schemas/Integrations.IntegrationId"
    },
    "local_metadata": {
      "$ref": "#/components/schemas/Integrations.ConnectionLocalMetadata"
    },
    "provider": {
      "$ref": "#/components/schemas/Integrations.ProviderResponse"
    },
    "public": {
      "$ref": "#/components/schemas/Integrations.ConnectionPublic"
    },
    "status": {
      "$ref": "#/components/schemas/Integrations.ConnectionStatus"
    },
    "user_id": {
      "$ref": "#/components/schemas/Common.UUID"
    },
    "workspace_id": {
      "$ref": "#/components/schemas/Common.UUID"
    }
  },
  "required": [
    "id",
    "status",
    "user_id",
    "integration_id",
    "workspace_id",
    "provider",
    "public",
    "local_metadata"
  ],
  "title": "Integrations.NotStartedConnectionResponse",
  "type": "object",
  "x-struct": "Elixir.AgiDbWeb.Schemas.Integrations.NotStartedConnectionResponse",
  "x-validate": null
}
```
Tokens:
Raw