Welcome to the Devin SDK documentation. This guide will help you get started with integrating and using the Devin SDK in your project.
- API version:
1.0.0
- SDK version:
1.0.0
This is an open API Spec for Devin, created internally by liblab. This is not an offical API Spec.
This SDK is compatible with the following versions: TypeScript >= 4.8.4
To get started with the SDK, we recommend installing using npm
:
npm install devin
The Devin API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
When you initialize the SDK, you can set the access token as follows:
const sdk = new Devin({ token: 'YOUR_TOKEN' });
If you need to set or update the access token after initializing the SDK, you can use:
const sdk = new Devin();
sdk.token = 'YOUR_TOKEN';
You can set a custom timeout for the SDK's HTTP requests as follows:
const devin = new Devin({ timeout: 10000 });
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
import { Devin } from 'devin';
(async () => {
const devin = new Devin({
token: 'YOUR_TOKEN',
});
const { data } = await devin.authStatus.authStatus();
console.log(data);
})();
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
Name |
---|
AuthStatusService |
SessionsService |
AttachmentsService |
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
Name | Description |
---|---|
AuthStatusOkResponse | |
CreateSessionRequest | |
CreateSessionOkResponse | |
GetSessionDetailsOkResponse | |
CreateV1AttachmentsRequest |
This SDK is licensed under the MIT License.
See the LICENSE file for more details.