Skip to Content

PylonApi

PylonApi icon
Arcade Starter

Tools that enable LLMs to interact directly with the pylon API.

Author:Arcade
Version:1.0.0
Auth:No authentication required
82tools
82require secrets
PyPI VersionPython VersionsWheel StatusDownloadsLicense

Arcade Toolkit Documentation Summary

The Arcade toolkit provides a robust set of tools for seamless interaction with the Pylon API, enabling developers to manage accounts, issues, and knowledge bases effectively. This toolkit allows developers to create, update, retrieve, and delete various resources within the Pylon ecosystem.

Capabilities

  • Create and manage accounts, issues, and custom fields.
  • Update details for existing records across multiple resource types.
  • Efficiently retrieve lists of users, accounts, and issues.
  • Implement search and filtering on diverse datasets.

Secrets

  • Token: PYLON_SECRET_TOKEN is required for API interactions.

Available tools(82)

82 of 82
Tool nameDescriptionSecrets
Creates a new activity for a specified account. Use this tool to add a new activity to an account by providing the account's internal or external ID. It will confirm the creation of the activity. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a highlight for a specified account. This tool is used to create a highlight for an account, using either an internal account ID in UUID format or an external ID in string format. It should be called when there is a need to add or update a highlight for an account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Generate an AI response for a specific issue. This tool creates an AI-generated response for a given issue by specifying the issue ID. It should be called when an automated response is required for issue resolution or documentation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new custom field in the system. Use this tool to add a custom field to your database or application configuration. It allows for extending the available data fields to include additional, personalized information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Creates a note on an issue to track additional details. This tool should be called when there's a need to add a note or comment to an existing issue to provide further information or updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a reply to an existing issue. Use this tool to add a comment or response to an existing issue when interaction or follow-up is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create an issue thread for an existing issue. Use this tool to initiate a discussion thread related to a specific issue by providing the issue ID. This helps in organizing conversations around particular issues efficiently.
1
Create and publish an article in a knowledge base. This tool allows the creation of a new article in a specified knowledge base, including optional translations. If the article is set to publish, translations will also be published. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new milestone in a project management system. This tool is used to create a milestone within a project management application. It should be called when there's a need to add a new milestone to track progress or set goals in a project. The tool confirms the creation of the milestone.
1
Creates a new user account. This tool should be called to create a new user account when registration or account opening is requested. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new collection in a knowledge base. This tool is used to create a new collection within a specified knowledge base by providing the knowledge base ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new contact in the system. This tool creates a new contact by sending the necessary details to the endpoint. Use it when you need to add a new person's contact information to the database. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new issue in the system. This tool is used to create a new issue in the system. It should be called whenever there's a need to log or track a new issue or task. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new project seamlessly. This tool is used to create a new project. It should be called when a user wants to initialize or start a new project within a system.
1
Create a new tag within the system. This tool is used to create a new tag by sending a POST request to the /tags endpoint. It should be called when a user wants to add a new tag to the system for organizational or categorization purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new team for collaboration. Use this tool to create a new team on the platform, facilitating collaboration and organization. It returns details about the newly created team.
1
Create a new route redirect for a knowledge base. This tool is used to create a new route redirect within a specified knowledge base. It should be called when you need to add a redirect to manage or alter the routing within a knowledge base. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new task with specified parameters. Use this tool to create a task. It should be called when a new task needs to be added to the system, specifying necessary parameters.
1
Create a new training data configuration. Call this tool to set up a new training data configuration for your application. It is used when you need to initialize or update your training data setup.
1
Delete an existing account. This tool deletes an existing account based on the provided account ID. Call this tool when you need to permanently remove an account.
1
Delete a specific highlight from an account. Use this tool to delete a specific highlight by providing the account ID and highlight ID. It should be called when a user wants to remove a highlight linked to an account.
1
Delete an existing article from a knowledge base. Call this tool to remove an article from a knowledge base by specifying the knowledge base and article IDs.
1
Delete an existing contact by ID. This tool deletes a contact by its ID. It should be called when a user needs to remove a contact from the system.
1
Delete an existing project using its ID. Use this tool to delete an existing project by providing the project ID. It allows you to manage and remove projects that are no longer needed.
1
Delete an existing tag by ID. Use this tool to delete an existing tag by specifying its ID. It confirms whether the deletion was successful.
1
Page 1 of 4(25 of 82)

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

PylonApi.CreateAccountActivity

Creates a new activity for a specified account. Use this tool to add a new activity to an account by providing the account's internal or external ID. It will confirm the creation of the activity. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
account_id_for_activitystringOptionalThe internal or external ID of the account to create the activity for. Accepts a UUID or any string format. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateActivity'.
#

PylonApi.CreateAccountHighlight

Create a highlight for a specified account. This tool is used to create a highlight for an account, using either an internal account ID in UUID format or an external ID in string format. It should be called when there is a need to add or update a highlight for an account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
account_identifierstringOptionalThe ID (UUID) or external ID (string) of the account for the highlight. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateAccountHighlight'.
#

PylonApi.CreateAiResponseForIssue

Generate an AI response for a specific issue. This tool creates an AI-generated response for a given issue by specifying the issue ID. It should be called when an automated response is required for issue resolution or documentation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
issue_idstringOptionalThe unique ID or number of the issue for which an AI response is required. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateIssueAIResponse'.
#

PylonApi.CreateCustomField

Create a new custom field in the system. Use this tool to add a custom field to your database or application configuration. It allows for extending the available data fields to include additional, personalized information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateCustomField'.
#

PylonApi.CreateIssueNote

Creates a note on an issue to track additional details. This tool should be called when there's a need to add a note or comment to an existing issue to provide further information or updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
issue_idstringOptionalThe unique identifier of the issue to which the note will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateIssueNote'.
#

PylonApi.CreateIssueReply

Create a reply to an existing issue. Use this tool to add a comment or response to an existing issue when interaction or follow-up is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
issue_idstringOptionalThe unique identifier of the issue to which you want to reply. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateIssueReply'.
#

PylonApi.CreateIssueThread

Create an issue thread for an existing issue. Use this tool to initiate a discussion thread related to a specific issue by providing the issue ID. This helps in organizing conversations around particular issues efficiently.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe ID for the issue you want to create a thread for. Required to link the thread to the correct issue.
thread_namestringOptionalThe title or name of the thread to be created. This should be descriptive of the discussion purpose.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateIssueThread'.
#

PylonApi.CreateKnowledgeBaseArticle

Create and publish an article in a knowledge base. This tool allows the creation of a new article in a specified knowledge base, including optional translations. If the article is set to publish, translations will also be published. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
knowledge_base_idstringOptionalThe unique identifier for the knowledge base where the article will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateArticle'.
#

PylonApi.CreateMilestone

Create a new milestone in a project management system. This tool is used to create a milestone within a project management application. It should be called when there's a need to add a new milestone to track progress or set goals in a project. The tool confirms the creation of the milestone.

Parameters

ParameterTypeReq.Description
milestone_namestringRequiredThe name of the milestone to be created. This is the title that will be displayed for the milestone.
project_id_for_milestonestringRequiredThe unique identifier for the project to which this milestone belongs. Required for associating the milestone with the correct project.
account_id_for_projectstringOptionalAccount ID for the project. This is needed to associate the milestone with the correct account.
milestone_due_datestringOptionalDue date for this milestone in RFC 3339 format (e.g., 2023-12-31T23:59:59Z).

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateMilestone'.
#

PylonApi.CreateNewAccount

Creates a new user account. This tool should be called to create a new user account when registration or account opening is requested. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateAccount'.
#

PylonApi.CreateNewCollection

Create a new collection in a knowledge base. This tool is used to create a new collection within a specified knowledge base by providing the knowledge base ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
knowledge_base_idstringOptionalThe unique identifier for the knowledge base where the new collection will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateCollection'.
#

PylonApi.CreateNewContact

Create a new contact in the system. This tool creates a new contact by sending the necessary details to the endpoint. Use it when you need to add a new person's contact information to the database. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateContact'.
#

PylonApi.CreateNewIssue

Create a new issue in the system. This tool is used to create a new issue in the system. It should be called whenever there's a need to log or track a new issue or task. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateIssue'.
#

PylonApi.CreateNewProject

Create a new project seamlessly. This tool is used to create a new project. It should be called when a user wants to initialize or start a new project within a system.

Parameters

ParameterTypeReq.Description
account_id_for_projectstringRequiredAccount ID associated with the project. This identifies the account under which the project will be created.
project_namestringRequiredThe name for the new project. This should be a descriptive and unique name to easily identify the project.
customer_portal_visiblebooleanOptionalBoolean indicating if the project should be visible in the customer portal. True makes it visible.
project_description_htmlstringOptionalHTML formatted description for the project, including any necessary tags and formatting.
project_end_datestringOptionalEnd date for the project in RFC 3339 format. Indicates when the project is expected to be finished.
project_owner_idstringOptionalThe unique identifier for the owner of the project. This is a string that specifies who will be managing or leading the project.
project_template_idstringOptionalThe ID of the template to be used for creating this project. It should match an existing project template ID.
start_datestringOptionalStart date for the project in RFC 3339 format (e.g., 2023-03-10T14:00:00Z).

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateProject'.
#

PylonApi.CreateNewTag

Create a new tag within the system. This tool is used to create a new tag by sending a POST request to the /tags endpoint. It should be called when a user wants to add a new tag to the system for organizational or categorization purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateTag'.
#

PylonApi.CreateNewTeam

Create a new team for collaboration. Use this tool to create a new team on the platform, facilitating collaboration and organization. It returns details about the newly created team.

Parameters

ParameterTypeReq.Description
team_namestringOptionalThe name to assign to the newly created team.
user_ids_to_addarray<string>OptionalA list of user IDs to include in the new team. Each user ID should be a string.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateTeam'.
#

PylonApi.CreateRouteRedirect

Create a new route redirect for a knowledge base. This tool is used to create a new route redirect within a specified knowledge base. It should be called when you need to add a redirect to manage or alter the routing within a knowledge base. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
knowledge_base_idstringOptionalThe unique identifier for the knowledge base where the route redirect will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateRouteRedirect'.
#

PylonApi.CreateTask

Create a new task with specified parameters. Use this tool to create a task. It should be called when a new task needs to be added to the system, specifying necessary parameters.

Parameters

ParameterTypeReq.Description
task_titlestringRequiredThe title of the task to be created. It should summarize the task clearly and concisely.
account_id_for_taskstringOptionalSpecify the Account ID associated with this task.
make_customer_portal_visiblebooleanOptionalSet to true to make the task visible on the customer portal, false to hide it.
milestone_idstringOptionalUnique identifier for the milestone associated with the task.
project_idstringOptionalUnique identifier for the project to which this task belongs.
task_assignee_idstringOptionalThe ID of the user to whom the task is assigned. It should be a valid user ID in the system.
task_body_htmlstringOptionalHTML content for the task body. Provide detailed information or instructions here using HTML formatting.
task_due_datestringOptionalDue date for the task, formatted in RFC 3339. Specify the date by which the task should be completed.
task_statusstringOptionalSet the task's current status: 'not_started', 'in_progress', or 'completed'.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateTask'.
#

PylonApi.CreateTrainingDataConfig

Create a new training data configuration. Call this tool to set up a new training data configuration for your application. It is used when you need to initialize or update your training data setup.

Parameters

ParameterTypeReq.Description
training_data_namestringOptionalThe name of the training data container to be created.
training_data_visibilitystringOptionalSpecifies who can access the training data. Valid options: "everyone", "user_only", "ai_agent_only". Defaults to "everyone".

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'CreateTrainingData'.
#

PylonApi.DeleteAccount

Delete an existing account. This tool deletes an existing account based on the provided account ID. Call this tool when you need to permanently remove an account.

Parameters

ParameterTypeReq.Description
account_idstringRequiredThe ID or external ID of the account to delete.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteAccount'.
#

PylonApi.DeleteAccountHighlight

Delete a specific highlight from an account. Use this tool to delete a specific highlight by providing the account ID and highlight ID. It should be called when a user wants to remove a highlight linked to an account.

Parameters

ParameterTypeReq.Description
account_identifierstringRequiredThe ID or external ID of the account that the highlight belongs to. Can be a UUID or any string.
highlight_idstringRequiredThe unique ID of the highlight you intend to delete.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteAccountHighlight'.
#

PylonApi.DeleteArticle

Delete an existing article from a knowledge base. Call this tool to remove an article from a knowledge base by specifying the knowledge base and article IDs.

Parameters

ParameterTypeReq.Description
article_idstringRequiredThe ID of the article that needs to be deleted from the knowledge base.
knowledge_base_idstringRequiredThe KnowledgeBaseID of the article to delete.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteArticle'.
#

PylonApi.DeleteContact

Delete an existing contact by ID. This tool deletes a contact by its ID. It should be called when a user needs to remove a contact from the system.

Parameters

ParameterTypeReq.Description
contact_idstringRequiredThe ID of the contact to be deleted.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteContact'.
#

PylonApi.DeleteExistingProject

Delete an existing project using its ID. Use this tool to delete an existing project by providing the project ID. It allows you to manage and remove projects that are no longer needed.

Parameters

ParameterTypeReq.Description
project_idstringRequiredThe unique identifier of the project to be deleted.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteProject'.
#

PylonApi.DeleteExistingTag

Delete an existing tag by ID. Use this tool to delete an existing tag by specifying its ID. It confirms whether the deletion was successful.

Parameters

ParameterTypeReq.Description
tag_idstringRequiredThe unique identifier of the tag to delete. Provide this ID to specify which tag should be removed.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteTag'.
#

PylonApi.DeleteIssue

Delete an existing issue by ID. Use this tool to delete an issue from the system by providing its ID. It is ideal for scenarios where issues need to be managed or cleaned up.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe unique identifier of the issue to delete.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteIssue'.
#

PylonApi.DeleteMilestone

Delete a specific milestone using its ID. Use this tool to remove a milestone by providing its unique ID. This operation is irreversible and should be used when a milestone is no longer needed.

Parameters

ParameterTypeReq.Description
milestone_idstringRequiredThe unique ID of the milestone to be deleted. Ensure it is correct as this action is irreversible.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteMilestone'.
#

PylonApi.DeleteTask

Delete an existing task by ID. Use this tool to delete a specific task by its ID. Call it when you need to remove a task permanently from the system.

Parameters

ParameterTypeReq.Description
task_idstringRequiredThe unique identifier of the task to be deleted.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteTask'.
#

PylonApi.DeleteTrainingDataDocuments

Deletes documents from a training data configuration. Use this tool to delete documents from a specific training data configuration by providing the relevant ID. This tool is helpful when managing or updating data sets for training purposes.

Parameters

ParameterTypeReq.Description
training_data_idstringRequiredThe ID of the training data from which documents will be deleted. Provide this to specify the exact dataset.
document_ids_to_deletearray<string>OptionalAn array of document IDs that need to be deleted from the training data configuration.
external_ids_to_deletearray<string>OptionalA list of external IDs to delete from the training data configuration.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'DeleteTrainingDataDocuments'.
#

PylonApi.FetchAllTags

Retrieve all available tags. Use this tool to obtain a comprehensive list of all tags. It is ideal for scenarios where you need to display or manage tags.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetTags'.
#

PylonApi.FetchTeamList

Retrieve the list of available teams. Use this tool to get a list of all teams from the service. Useful for displaying team information or selecting a team from the list.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetTeams'.
#

PylonApi.GetAccountInfo

Retrieve an account's details using its ID or external ID. Call this tool to obtain detailed information about an account by providing either the account ID or external ID.

Parameters

ParameterTypeReq.Description
account_idstringRequiredThe ID or external ID of the account to fetch.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetAccount'.
#

PylonApi.GetAccountList

Retrieve a list of accounts from the service. This tool fetches a complete list of accounts from the Pylon service. It should be called when you need to obtain account information.

Parameters

ParameterTypeReq.Description
account_fetch_limitintegerRequiredSpecify the number of accounts to fetch, from 1 to 999. Defaults to 100 if not specified.
pagination_cursorstringOptionalA string representing the cursor for pagination. Use this to fetch the next set of accounts.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetAccounts'.
#

PylonApi.GetAllContacts

Retrieve all contacts from the service. This tool retrieves all contacts using the Pylon service. It should be called when there's a need to fetch a complete list of contacts from the service.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetContacts'.
#

PylonApi.GetAllCustomFields

Retrieve all custom fields from the system. This tool is used to get a complete list of custom fields. It should be called when you need information about available custom fields.

Parameters

ParameterTypeReq.Description
custom_field_object_typestringRequiredSpecify the object type for custom fields. Options: "account", "issue", or "contact".

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetCustomFields'.
#

PylonApi.GetCollectionById

Retrieve a specific collection using its ID. Use this tool to obtain detailed information about a particular collection by supplying the collection ID. The collection belongs to a specific knowledge base. Ideal for retrieving specific datasets or information collections within larger systems.

Parameters

ParameterTypeReq.Description
collection_idstringRequiredThe unique ID of the collection to be retrieved from the knowledge base.
knowledge_base_idstringRequiredThe ID of the knowledge base to which the collection belongs.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetCollection'.
#

PylonApi.GetContactById

Retrieve contact details using the contact ID. This tool fetches and returns contact details by querying with a specified contact ID. Use it when you need to obtain specific contact information.

Parameters

ParameterTypeReq.Description
contact_idstringRequiredThe unique identifier for the contact to fetch details.
number_of_accounts_to_fetchintegerRequiredSpecifies the number of accounts to fetch. Must be between 1 and 999. Defaults to 100 if not provided.
pagination_cursorstringOptionalA string representing the cursor for pagination purposes, used to fetch the next set of results in a paginated response.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetContact'.
#

PylonApi.GetCustomActivityTypes

Retrieve a list of custom activity types. Use this tool to get a list of custom activity types that are available. It should be called when there's a need to know what custom activity types exist.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetActivityTypes'.
#

PylonApi.GetCustomField

Retrieve a custom field by its ID. Use this tool to obtain details of a specific custom field using its unique identifier.

Parameters

ParameterTypeReq.Description
custom_field_idstringRequiredThe unique identifier of the custom field to retrieve.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetCustomField'.
#

PylonApi.GetIssueById

Retrieve issue details using its ID or number. Use this tool to access details of an issue by providing its specific ID or number. Ideal for tasks requiring detailed issue information retrieval in issue tracking systems.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe unique ID or number of the issue you want to retrieve.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetIssue'.
#

PylonApi.GetIssueFollowers

Get followers of a specific issue to manage participation. This tool retrieves the list of users who are following a specified issue. Use this tool when you need to know who is engaging with or interested in updates about an issue.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe unique ID or number of the issue to retrieve followers for.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetIssueFollowers'.
#

PylonApi.GetIssueMessages

Retrieve messages for a specific issue. This tool is used to obtain all messages associated with a particular issue, identified by its ID.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe unique ID of the issue for which to retrieve messages.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetIssueMessages'.
#

PylonApi.GetIssuesList

Retrieve a list of issues. Call this tool to get a list of issues from the Pylon service, useful for tracking or managing tasks and bugs.

Parameters

ParameterTypeReq.Description
end_time_rfc3339stringRequiredThe end time in RFC3339 format for the issue retrieval range, must be within 30 days of the start time.
start_time_for_issue_rangestringRequiredThe start time in RFC3339 format to query issues. Duration with end_time must be <= 30 days.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetIssues'.
#

PylonApi.GetIssueStatuses

Retrieve all issue statuses from the system. Use this tool to get a complete list of issue statuses available in the project management system. This can help with tracking and managing project workflows efficiently.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetIssueStatuses'.
#

PylonApi.GetIssueThreads

Retrieve threads for a specific issue. Call this tool to get all threads associated with a particular issue using its ID. Useful for tracking conversations or discussions related to an issue.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe unique ID of the issue for which threads need to be retrieved.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetIssueThreads'.
#

PylonApi.GetKnowledgeBaseById

Retrieve a knowledge base using its ID. Use this tool to fetch information about a specific knowledge base by providing its ID.

Parameters

ParameterTypeReq.Description
knowledge_base_idstringRequiredThe unique identifier for the knowledge base to be retrieved.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetKnowledgeBase'.
#

PylonApi.GetKnowledgeBases

Retrieve all available knowledge bases. This tool is called to get a list of all knowledge bases from the Pylon service.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetKnowledgeBases'.
#

PylonApi.GetOrganizationDetails

Retrieve details of the current organization. Use this tool to get information about the organization linked to the given API token, like name, address, and other relevant details.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetMe'.
#

PylonApi.GetTagById

Retrieve tag details using a specified ID.

Parameters

ParameterTypeReq.Description
tag_idstringRequiredThe unique identifier for the tag to retrieve details.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetTag'.
#

PylonApi.GetTeamById

Retrieve team details using the team's ID. Use this tool to get detailed information about a team by specifying its unique ID.

Parameters

ParameterTypeReq.Description
team_idstringRequiredThe unique ID of the team to retrieve details for.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetTeam'.
#

PylonApi.GetTicketForm

Retrieve detailed information about a ticket form. Call this tool to obtain detailed information for a specific ticket form by providing its ID.

Parameters

ParameterTypeReq.Description
ticket_form_idstringRequiredThe unique ID of the ticket form to retrieve.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetTicketForm'.
#

PylonApi.GetTicketForms

Retrieve a list of ticket forms available. This tool fetches a list of ticket forms, which can be used to understand the structure of available forms for managing tickets. It should be called when you need to review or select from ticket forms.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetTicketForms'.
#

PylonApi.GetUserById

Retrieve user details using their unique ID. Use this tool to get detailed information about a user by providing their unique ID.

Parameters

ParameterTypeReq.Description
user_idstringRequiredThe unique ID of the user to fetch details for.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetUser'.
#

PylonApi.GetUserRoles

Get a list of all user roles. Use this tool to retrieve a comprehensive list of all user roles. It is useful for managing and understanding user permissions.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetUserRoles'.
#

PylonApi.ImportIssue

Import an issue into the system. This tool is used to import an issue into the Pylon system. Use it when you need to add new issues by importing them through a specified format or integration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'ImportIssue'.
#

PylonApi.ImportMessagesToIssue

Import messages into an existing issue. Use this tool to import new messages onto an existing issue, facilitating better organization and tracking within issue management systems. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
issue_idstringOptionalThe unique ID of the existing issue to which messages will be imported. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'ImportMessages'.
#

PylonApi.ImportNewContact

Import a new contact into the system. Use this tool to import a new contact into the system whenever you need to add contact information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'ImportContact'.
#

PylonApi.LinkExternalIssue

Link or unlink external issues to an internal issue. Use this tool to link external issues to an internal issue or unlink them by specifying the operation type. Ideal for managing issue relationships between different systems. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
issue_identifierstringOptionalThe unique ID or number of the internal issue to which external issues should be linked or unlinked. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'LinkExternalIssue'.
#

PylonApi.ListCollectionsInKnowledgeBase

List all collections in a knowledge base. Use this tool to retrieve all collections within a specific knowledge base. Useful for accessing organized information in structured formats.

Parameters

ParameterTypeReq.Description
knowledge_base_idstringRequiredThe ID of the knowledge base to list the collections from.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetCollections'.
#

PylonApi.ListTrainingData

Fetches all training data configurations for the organization. Use this tool to retrieve a comprehensive list of training data configurations associated with the organization. Ideal for managing or reviewing training datasets.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'ListTrainingData'.
#

PylonApi.ListUsers

Fetches a list of users. Use this tool to retrieve a list of all users. It provides an overview of the users available in the system.

Parameters

No parameters required.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetUsers'.
#

PylonApi.RedactMessage

Removes or hides the content of a specified message. Use this tool to redact (remove or hide) the content of a message identified by a specific message ID within an issue. This is useful for maintaining privacy or correcting errors.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe ID of the issue associated with the message to be redacted.
message_idstringRequiredThe unique identifier of the message to be redacted.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'RedactMessage'.
#

PylonApi.RetrieveTrainingDataConfiguration

Retrieve a training data configuration by ID. This tool retrieves the details of a specific training data configuration using its unique ID. It should be called when you need to access the configuration settings or specifications for a particular training dataset.

Parameters

ParameterTypeReq.Description
training_data_idstringRequiredThe unique ID of the training data to retrieve its configuration.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'GetTrainingData'.
#

PylonApi.SearchAccounts

Search and filter accounts using various criteria. This tool allows searching and filtering of accounts with specific criteria such as domains, tags, name, external IDs, and custom fields. It supports operators like 'contains', 'equals', 'in', 'not_in', and others, enabling detailed account queries. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'SearchAccounts'.
#

PylonApi.SearchContacts

Search for contacts using various filter criteria. This tool allows you to search for contacts by applying filters on fields such as id, email, custom fields, and account_id. Use it to find specific contacts based on these criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'SearchContacts'.
#

PylonApi.SearchIssuesByFilters

Search for issues using various filters and criteria. Use this tool to search for issues by applying filters such as creation date, account ID, requester ID, status, tags, title, and more. Suitable for retrieving specific issues according to predefined criteria and operators. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'SearchIssues'.
#

PylonApi.SearchUsersByEmail

Search for users by email with filter options. Use this tool to find users by filtering their email with options such as 'equals', 'in', or 'not_in'. It should be called when there's a need to retrieve user information based on specific email criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'SearchUsers'.
#

PylonApi.SnoozeIssue

Temporarily pause notifications for an issue. Use this tool to snooze notifications for a specific issue temporarily. It is helpful when you want to focus elsewhere without getting alerts for the issue. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
issue_idstringOptionalThe ID or number of the issue to snooze. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'SnoozeIssue'.
#

PylonApi.UpdateAccount

Update details of an existing account. Use this tool to modify the information of an existing account by providing the account ID and new details. It should be called when account information needs to be updated. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
account_idstringOptionalThe ID or external ID of the account to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateAccount'.
#

PylonApi.UpdateAccountHighlight

Updates the highlight for a specified account. Use this tool to update the highlight information for a given account by specifying either the internal account ID or an external ID. Appropriate when modifications to account highlights are needed.

Parameters

ParameterTypeReq.Description
account_identifierstringRequiredThe internal account ID (UUID) or external ID (any string) of the account associated with the highlight.
highlight_idstringRequiredThe unique identifier of the highlight you wish to update. Ensure this accurately corresponds to the highlight needing modification.
updated_expiration_timestampstringOptionalThe new expiration timestamp for the highlight in RFC3339 format.
updated_html_contentstringOptionalThe updated HTML content for the account highlight.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateAccountHighlight'.
#

PylonApi.UpdateArticle

Update the content of an existing article. Use this tool to modify the content or details of an existing article in a knowledge base when updates are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
knowledge_base_idstringOptionalThe identifier for the knowledge base where the article to be updated is located. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
article_idstringOptionalSpecify the unique identifier of the article you want to update in the knowledge base. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateArticle'.
#

PylonApi.UpdateContactInfo

Updates an existing contact's information. Use this tool to update the details of an existing contact when modifications are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
contact_idstringOptionalThe unique identifier of the contact to be updated. This should match the existing contact's ID in the system. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateContact'.
#

PylonApi.UpdateCustomField

Update a custom field in a record. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
custom_field_idstringOptionalThe unique identifier for the custom field to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateCustomField'.
#

PylonApi.UpdateExistingTag

Update an existing tag's information. Use this tool to modify the details of an already existing tag. It should be called when changes to tag attributes are needed.

Parameters

ParameterTypeReq.Description
tag_idstringRequiredThe unique identifier of the tag that needs to be updated.
tag_hex_colorstringOptionalThe hex code representing the tag's color. Must be a valid six-digit hexadecimal value prefixed with '#'.
tag_namestringOptionalThe new name for the tag to be updated.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateTag'.
#

PylonApi.UpdateExistingTeam

Update details of an existing team. Use this tool to modify the information of an existing team. Ideal for updating team names, members, or other details.

Parameters

ParameterTypeReq.Description
team_idstringRequiredThe ID of the team to update.
team_member_user_idsarray<string>OptionalThe list of user IDs to set as team members. This updates the team to include only these users.
team_namestringOptionalThe new name for the team to be updated.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateTeam'.
#

PylonApi.UpdateIssue

Update details of an existing issue. Use this tool to modify information for an already existing issue when changes or corrections are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
issue_idstringOptionalThe ID of the issue to update. This should be a string representing the unique identifier for the issue. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateIssue'.
#

PylonApi.UpdateIssueFollowers

Add or remove followers for an issue. This tool allows you to add or remove followers to a specific issue. Use it when managing the users who should receive notifications about updates on an issue. Set the operation field to "remove" to remove followers.

Parameters

ParameterTypeReq.Description
issue_idstringRequiredThe ID or number of the issue to add or remove followers from.
contact_ids_to_addarray<string>OptionalAn array of contact IDs to add as followers to the issue. Each ID should be a string.
update_operationstringOptionalSpecify 'add' to add followers or 'remove' to remove them.
user_ids_to_add_as_followersarray<string>OptionalList of user IDs to add as followers to a specific issue.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'AddIssueFollowers'.
#

PylonApi.UpdateMilestone

Updates the details of a specific milestone. This tool is used to update information for a specific milestone in a project, identified by its ID.

Parameters

ParameterTypeReq.Description
milestone_idstringRequiredThe unique ID of the milestone to update.
milestone_due_datestringOptionalThe due date for the milestone in RFC 3339 format (e.g., 2023-10-21T00:00:00Z).
milestone_namestringOptionalThe new name for the milestone you want to update.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateMilestone'.
#

PylonApi.UpdateMultipleAccounts

Update multiple accounts simultaneously. Use this tool to update details for multiple accounts in one request. It is helpful for batch processing of account modifications. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateAccounts'.
#

PylonApi.UpdateProject

Update the details of an existing project. Use this tool to modify the information of an existing project by providing the project ID and necessary updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
project_idstringOptionalThe unique identifier of the project to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_namestringOptionalThe new name for this project. Provide a descriptive title to identify the project. Only used when mode is 'execute'.
project_description_htmlstringOptionalHTML formatted description for the project. Only used when mode is 'execute'.
start_date_rfc3339stringOptionalThe start date for the project, formatted in RFC 3339. This specifies when the project begins. Only used when mode is 'execute'.
project_end_datestringOptionalThe end date for the project in RFC 3339 format. Only used when mode is 'execute'.
project_owner_idstringOptionalThe unique identifier of the owner of this project. Required to assign an owner when updating a project. Only used when mode is 'execute'.
is_customer_portal_visiblebooleanOptionalIndicate if the project should be visible in the customer portal (true for visible, false for hidden). Only used when mode is 'execute'.
is_project_archivedbooleanOptionalSet to True if the project is archived, False if it is active. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateProject'.
#

PylonApi.UpdateTask

Update the details of an existing task. Use this tool to modify the information of a specific task by providing its ID. Ideal for updating any details like status, description, or due date.

Parameters

ParameterTypeReq.Description
task_idstringRequiredThe unique ID of the task you want to update.
assignee_idstringOptionalThe ID of the person assigned to this task. It should be a string representing a valid user ID within the system.
customer_portal_visiblebooleanOptionalSet to true to make the task visible on the customer portal. Accepts a boolean.
milestone_identifierstringOptionalSpecify the Milestone ID associated with the task to update its milestone.
project_idstringOptionalThe unique identifier of the project associated with this task. Required to specify which project's task is being updated.
task_body_htmlstringOptionalHTML content for the task's body. This defines the main description or details of the task.
task_due_datestringOptionalDue date for the task in RFC 3339 format, e.g., '2023-12-31T23:59:59Z'.
task_statusstringOptionalSpecify the task status: `not_started`, `in_progress`, or `completed`.
task_titlestringOptionalThe new title for the task. Provide a clear and concise title for better understanding.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateTask'.
#

PylonApi.UpdateUserProfile

Update a user's profile information. This tool updates the information of a user identified by a specific ID. It should be called when changes to a user's profile are needed, such as updating personal details or contact information.

Parameters

ParameterTypeReq.Description
user_idstringRequiredThe unique identifier of the user to be updated.
user_role_idstringOptionalThe role ID to assign to the user.
user_statusstringOptionalThe updated status for the user. Options: `active`, `away`, or `out_of_office`.

Requirements

Secrets:PYLON_SECRET_TOKEN

Output

Type:json— Response from the API endpoint 'UpdateUser'.
Last updated on