Docyrus Api Dev

What it does

This skill provides guidance and assistance for interacting with the Docyrus API. It enables AI agents to authenticate using OAuth2 PKCE, query data sources through REST endpoints with filtering and aggregation capabilities, and manage user accounts. The skill leverages the @docyrus/api-client (REST client) and @docyrus/signin (React authentication provider) libraries for seamless integration.

When to use it

• When needing to retrieve or modify data stored within Docyrus data sources.
• For automating user management tasks, such as creating or updating user profiles.
• To build applications requiring authentication and authorization against the Docyrus platform.
• When integrating with Docyrus APIs in React applications or non-React/server environments.

Key capabilities

• Authentication: Supports OAuth2 PKCE for secure authentication.
• REST API Interaction: Enables querying, creating, updating, and deleting data source items via REST endpoints.
• Data Filtering & Aggregation: Allows filtering and aggregating data when retrieving information from data sources.
• React Integration: Provides a React auth provider (@docyrus/signin) for easy integration into React applications.
• Server-Side Authentication: Offers direct OAuth2 client usage for non-React environments.
• API Endpoint Access: Facilitates access to both Data Source Items (tenant-specific) and System Endpoints (always available).

Example prompts

• "Retrieve all items from the 'MyDataSource' data source."
• "Create a new user with email '[email protected]'."
• "Update my profile information in Docyrus."
• "List all users in the system."

Tips & gotchas

• API Key/Credentials: You will need to configure your application with valid Docyrus API credentials (client ID, redirect URI).
• Tenant-Specific Endpoints: Data source endpoints are dynamic and depend on the tenant's configuration. Refer to the OpenAPI specification (GET /v1/api/openapi.json) for available endpoints.
• Authentication Flow: Understand the OAuth2 PKCE flow for proper authentication in both React and non-React environments.