Pylon

https://docs.usepylon.com/pylon-docs
Admin
Pylon is the first B2B support platform that tracks customer issues across various channels,...
Tokens:182,793
Snippets:1,220
Trust Score:9.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Querying Documentation via HTTP GET

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/attachments

This example demonstrates how to ask questions about the documentation by making an HTTP GET request to the current page URL with an 'ask' query parameter. The response will contain answers and relevant excerpts.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/attachments.md?ask=<question>
```

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

### Dynamic Documentation Query Example

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/user-roles

Demonstrates how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/user-roles.md?ask=<question>
```

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

### Example GET API Call Definition

Source: https://docs.usepylon.com/pylon-docs/ai-agents/build/runbooks

This snippet shows an example of how a GET API call can be defined within Pylon. It illustrates the structure for making external requests.

```json
{
  "name": "Get customer details",
  "description": "Retrieves customer details using their ID.",
  "action": {
    "type": "api",
    "method": "GET",
    "url": "https://api.example.com/customers/{{customer_id}}",
    "headers": {
      "Authorization": "Bearer {{api_key}}"
    }
  }
}
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/integrations/codebase

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic answers to specific questions about the documentation.

```HTTP
GET https://docs.usepylon.com/pylon-docs/integrations/codebase.md?ask=<question>
```

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

### Runbook Step Example

Source: https://docs.usepylon.com/pylon-docs/ai-agents/build/runbooks

An example of a single step within a Runbook. This step uses natural language to instruct the AI agent, including a variable for account ID.

```natural language
Respond to the customer with a message that includes their account ID, which is a 5 digit alphanumeric value.
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/users

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic information. The question should be specific and self-contained.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/users.md?ask=<question>
```

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

### Query Documentation API Example

Source: https://docs.usepylon.com/pylon-docs/chat-widget/chat-setup

Demonstrates how to query the documentation dynamically by appending an 'ask' parameter with a question to the documentation URL.

```http
GET https://docs.usepylon.com/pylon-docs/chat-widget/chat-setup.md?ask=<question>
```

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

### Get All Accounts

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts

Retrieves a list of all accounts. This is a basic GET request to the accounts endpoint.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Pylon API.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.usepylon.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "Authorization: Bearer <token>",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "paths": {
    "/accounts": {
      "get": {
        "tags": [
          "accounts"
        ],
        "summary": "List all accounts",
        "operationId": "ListAccounts",
        "responses": {
          "200": {
            "description": ""
          }
        }
      }
    }
  }
}
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/integrations/ticketing/github-issues

You can ask questions about the documentation by performing an HTTP GET request with the 'ask' query parameter. The response will include a direct answer and relevant excerpts.

```bash
GET https://docs.usepylon.com/pylon-docs/integrations/ticketing/github-issues.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.usepylon.com/pylon-docs/reporting-and-analytics/analytics

To get specific information not directly on a page, make an HTTP GET request to the page URL with an 'ask' query parameter. The question should be clear and in natural language.

```bash
GET https://docs.usepylon.com/pylon-docs/reporting-and-analytics/analytics.md?ask=<question>
```

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

### Create a Project

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tasks-and-projects

Creates a new project for an account. Rate limit is 60 requests per minute.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Pylon API.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.usepylon.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "Authorization: Bearer <token>",
        "scheme": "bearer",
        "type": "http"
      }
    },
    "schemas": {
      "CreateProjectRequestBody": {
        "properties": {
          "account_id": {
            "description": "Account ID for this project",
            "type": "string"
          },
          "customer_portal_visible": {
            "default": false,
            "description": "Customer portal visible for this project",
            "type": "boolean"
          },
          "description_html": {
            "description": "Description HTML for this project",
            "type": "string"
          },
          "end_date": {
            "description": "End date for this project, in RFC 3339 format",
            "type": "string"
          },
          "name": {
            "description": "Name for this project",
            "type": "string"
          },
          "owner_id": {
            "description": "Owner ID for this project",
            "type": "string"
          },
          "project_template_id": {
            "description": "Project template ID for this project",
            "type": "string"
          },
          "start_date": {
            "description": "Start date for this project, in RFC 3339 format",
            "type": "string"
          }
        },
        "required": [
          "account_id",
          "name"
        ],
        "type": "object"
      },
      "CreateProjectResponseBody": {
        "properties": {
          "data": {
            "$ref": "#/components/schemas/Project"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "Project": {
        "properties": {
          "account": {
            "$ref": "#/components/schemas/MiniAccount"
          },
          "archived_at": {
            "description": "The archived at time of the project in RFC3339 format.",
            "type": "string"
          },
          "created_at": {
            "description": "The created at time of the project.",
            "type": "string"
          },
          "custom_fields": {
            "additionalProperties": {
              "$ref": "#/components/schemas/CustomFieldValue"
            },
            "description": "Custom fields for this project, keyed by slug.",
            "type": "object"
          },
          "customer_portal_visible": {
            "description": "The customer portal visible of the project.",
            "type": "boolean"
          },
          "description_html": {
            "description": "The description of the project in HTML format.",
            "type": "string"
          },
          "end_date": {
            "description": "The end date of the project in RFC3339 format.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the project.",
            "type": "string"
          },
          "is_archived": {
            "description": "Whether the project is archived.",
            "type": "boolean"
          },
          "name": {
            "description": "The name of the project.",
            "type": "string"
          },
          "owner_id": {
            "description": "The owner ID of the project.",
            "type": "string"
          },
          "project_template": {
            "$ref": "#/components/schemas/MiniProjectTemplate"
          },
          "start_date": {
            "description": "The start date of the project in RFC3339 format.",
            "type": "string"
          },
          "updated_at": {
            "description": "The updated at time of the project.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "MiniAccount": {
        "properties": {
          "external_ids": {
            "description": "External IDs associated with the account.",
            "items": {
              "$ref": "#/components/schemas/ExternalID"
            },
            "type": "array"
          },
          "id": {
            "description": "The ID of the account.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ExternalID": {
        "properties": {
          "external_id": {
            "description": "The external ID. Must be unique per object type (ex. account).",
            "type": "string"
          },
          "label": {
            "description": "The label of the external ID. Must be unique per object.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "CustomFieldValue": {
        "properties": {
          "slug": {
            "description": "The slug of the custom field.",
            "type": "string"
          },
          "value": {
            "description": "The value of the custom field. Only to be used for single-valued custom fields. If unset, the custom field will be unset. If the custom field is a select field, the value must be the select option slug, which you can find from the GET /custom-fields endpoint.",
            "type": "string"
          },
          "values": {
            "description": "The values of the custom field. Only to be used for multi-valued custom fields (ex. multiselect). If unset, the custom field will be unset. If the custom field is a multiselect field, the values must be the select option slugs which you can find from the GET /custom-fields endpoint.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "MiniProjectTemplate": {
        "properties": {
          "id": {
            "description": "The ID of the project template.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorApiResponseBody": {
        "properties": {
          "errors": {
            "description": "The list of errors.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "exists_id": {
            "description": "The ID of the object that already exists if this is a duplicate object error.",
            "type": "string"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "paths": {
    "/projects": {
      "post": {
        "description": "Creates a new project for an account.\n\n**Rate limit:** 60 requests per minute",
        "operationId": "CreateProject",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateProjectRequestBody"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateProjectResponseBody"
                }
              }
            },
            "description": ""
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorApiResponseBody"
                }
              }
            },
            "description": ""
          },
          "404": {
            "content": {
              "application/json": {
                "sche"
              }
            }
          }
        }
      }
    }
  }
}
```

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

### Query Documentation via HTTP GET

Source: https://docs.usepylon.com/pylon-docs/integrations/ticketing/linear

To get information not explicitly present on the page, make an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.usepylon.com/pylon-docs/integrations/ticketing/linear.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/account-intelligence/accounts/views

Use this GET request to ask questions about the documentation. The response includes direct answers and relevant excerpts.

```http
GET https://docs.usepylon.com/pylon-docs/account-intelligence/accounts/views.md?ask=<question>
```

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

### Get Account by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts

Retrieves a specific account by its ID. This is a GET request to the /accounts/{id} endpoint.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Pylon API.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.usepylon.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "Authorization: Bearer <token>",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "paths": {
    "/accounts/{id}": {
      "get": {
        "tags": [
          "accounts"
        ],
        "summary": "Get account",
        "operationId": "GetAccount",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "404": {
            "description": ""
          }
        }
      }
    }
  }
}
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/support-workflows/issues/sidebar

Use this HTTP GET request to ask questions about the documentation. Include your question as the value for the 'ask' query parameter.

```http
GET https://docs.usepylon.com/pylon-docs/support-workflows/issues/sidebar.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/ai-agents/deploy

Use this HTTP GET request to ask questions about the documentation. Include your specific question in the 'ask' query parameter. The response will provide a direct answer with relevant excerpts and sources.

```http
GET https://docs.usepylon.com/pylon-docs/ai-agents/deploy.md?ask=<question>
```

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

### Get All Users

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/users

Retrieves a list of all users. This endpoint uses the GET method and is documented via OpenAPI.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/users.md?ask=get all users
```

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

### Query Documentation with 'ask' Parameter

Source: https://docs.usepylon.com/pylon-docs/account-intelligence/fields/formulas

This example demonstrates how to dynamically query Pylon documentation by appending an 'ask' query parameter to the URL with a natural language question. The response includes direct answers and relevant excerpts.

```HTTP Request
GET https://docs.usepylon.com/pylon-docs/account-intelligence/fields/formulas.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.usepylon.com/pylon-docs/ai-agents/build/resources

To get information not directly on a page, perform an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language. The response includes the answer, excerpts, and sources.

```HTTP
GET https://docs.usepylon.com/pylon-docs/ai-agents/build/resources.md?ask=<question>
```

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

### Example Custom App Structure

Source: https://docs.usepylon.com/pylon-docs/developer/custom-apps

Demonstrates a complete JSON structure for a custom application, including header and various components like card, text, date, badge, button, link, and divider.

```json
{
  "version": "1.0.0",
  "header": {
    "title": "Sample Header",
    "icon_url": "http://example.com/icon.png"
  },
  "components": [
    {
      "type": "card",
      "components": [
        {
          "type": "text",
          "label": "Nested Text",
          "value": "This is nested text",
          "icon_url": "http://example.com/nested-text-icon.png"
        }
      ]
    },
    {
      "type": "text",
      "label": "Sample Text",
      "value": "This is a sample text",
      "icon_url": "http://example.com/text-icon.png"
    },
    {
      "type": "date_time",
      "label": "Sample Date",
      "value": "2024-07-15T12:34:56Z",
      "icon_url": "http://example.com/date-icon.png"
    },
    {
      "type": "badge",
      "label": "Sample Badge",
      "items": [
        {
          "value": "Badge 1",
          "color": "blue"
        },
        {
          "value": "Badge 2",
          "color": "green"
        }
      ]
    },
    {
      "type": "button",
      "label": "Click Me",
      "button_type": "link",
      "url": "http://example.com"
    },
    {
      "type": "link",
      "label": "Example Link",
      "url": "http://example.com"
    },
    {
      "type": "divider"
    }
  ]
}
```

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

### Get All Teams

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/teams

Retrieves a list of all teams in the system. This uses the OpenAPI specification for the `/teams` endpoint with a GET method.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/teams.md?ask=list all teams
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/account-intelligence/activities/custom-activities

Use this GET request to query the documentation with a specific question. The response includes direct answers and relevant excerpts.

```bash
GET https://docs.usepylon.com/pylon-docs/account-intelligence/activities/custom-activities.md?ask=<question>
```

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

### Get All Tags

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tags

Retrieves a list of all tags. This operation uses the OpenAPI specification to define the GET request for the /tags endpoint.

```openapi
{% openapi src="<https://static.usepylon.com/openapi.json>" path="/tags" method="get" %}
<https://static.usepylon.com/openapi.json>
{% endopenapi %}
```

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

### Get Contact by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/contacts

Retrieves a specific contact by its unique identifier. Use this endpoint to get details of a single contact.

```APIDOC
## GET /contacts/{id}

### Description
Retrieves a specific contact by its unique identifier.

### Method
GET

### Endpoint
/contacts/{id}

#### Path Parameters
- **id** (string) - Required - The unique identifier of the contact.
```

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

### Create a Project

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tasks-and-projects

Use this endpoint to create a new project. Ensure you have the correct API key and project details.

```json
{
  "name": "My New Project",
  "description": "This is a sample project created via the API."
}
```

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

### Get User by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/users

Retrieves a specific user by their unique identifier. This endpoint uses the GET method and is documented via OpenAPI.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/users.md?ask=get user by id
```

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

### Querying Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/account-intelligence/accounts/personal-email

You can ask questions about the documentation by performing an HTTP GET request with the 'ask' query parameter. The response will contain a direct answer and relevant excerpts from the documentation.

```HTTP
GET https://docs.usepylon.com/pylon-docs/account-intelligence/accounts/personal-email.md?ask=<question>
```

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

### Querying Documentation

Source: https://docs.usepylon.com/pylon-docs/support-workflows/assignment-rules

To get more information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```bash
GET https://docs.usepylon.com/pylon-docs/support-workflows/assignment-rules.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/audit-logs

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to ask specific questions about the documentation. The response includes direct answers and relevant excerpts.

```bash
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/audit-logs.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/account-intelligence

You can ask questions about the documentation by performing an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information or clarification not explicitly present on the page.

```http
GET https://docs.usepylon.com/pylon-docs/account-intelligence.md?ask=<question>
```

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

### Get User by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/users

Retrieves details for a specific user identified by their unique ID. Use this endpoint to get comprehensive information about a single user.

```APIDOC
## GET /users/{id}

### Description
Retrieves details for a specific user.

### Method
GET

### Endpoint
/users/{id}

#### Path Parameters
- **id** (string) - Required - The unique identifier of the user.

### Response
#### Success Response (200)
- **user** (object) - A user object with detailed information.
```

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

### Get Training Data by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/training-data

Retrieves a specific training data entry by its unique identifier. Use this to get details about a particular knowledge source.

```APIDOC
## GET /training-data/{id}

### Description
Retrieves a specific training data entry by its unique identifier.

### Method
GET

### Endpoint
/training-data/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the training data entry.
```
Tokens:
Raw