API Documentation
Introduction
4 mins read
Introduction
Essential documentation for utilizing the Induced API to manage browser sessions and automate tasks with natural language
The Induced Dev Environment API is designed to enable developers to create browser sessions and execute automated steps through natural language commands. This document outlines the use of the API and provides guidance on getting started.
Base URL
This API empowers developers to create, manage, and interact with browser sessions programmatically. Utilizing natural language processing, the Induced Development Environment provides a robust interface for automation tasks in a browser context.
https://api.induced.ai/v1/develop
copy
Authentication
To maintain security and integrity, all API requests require authentication. Include yourx-api-keyin the headers of each request.
x-api-key: [API_KEY_HERE]
copy
Response codes
Understanding the significance of each HTTP response code will guide you in handling API requests effectively. Here’s what each one indicates
200
Success
Your request was executed successfully.
400
Bad Request
The request was malformed or contains an error preventing it from being fulfilled.
401
Unauthorized
Authentication credentials are missing or incorrect.
403
Forbidden
The server understands the request but refuses to authorize it.
404
Not Found
The server understands the request but refuses to authorize it.
505
Internal Server Error
The server understands the request but refuses to authorize it.
Each code is part of a broader categorization where2xxcodes represent successful operations,4xxcodes indicate client errors, and5xxcodes point to server errors. Pay close attention to these in your integration to ensure smooth functionality.
Fair Usage Policy
Our API implements a fair usage policy to ensure service reliability and equitable access for all users. Rate limiting may apply, and if you encounter any limits, please be patient and wait before sending additional requests.
Getting support
For assistance or to report any issues with the API, please contact our support team via email at support@induced.ai
Reach out directly via email for inquiries or assistance regarding the Induced Development Environment API. Our team is committed to providing timely and helpful support to ensure your success.
Caveats
As the Induced API is in beta, we are continually refining our features. While changes are anticipated, we strive to limit any that are breaking:
- The API and its schema may change at any time without prior notice. Please keep this in mind when integrating with your applications.
- Some of the features described in this documentation may not be available in the beta release. We are working hard to implement them as soon as possible.
- There could be scenarios where the step is not correctly executed but has been marked as completed. We’re working on improving the accuracy of our step execution and verification as well.
Last updated 1 week ago
Was this helpful?
Yes
No
Webhooks