API Reference for DocuCraft
Authentication#
| Parameter/Command |
Type |
Description |
Example |
api_key |
string |
Your unique API key for authentication. |
api_key=your_api_key |
auth_type |
string |
Type of authentication used. |
auth_type=Bearer |
Documentation Management#
| Parameter/Command |
Type |
Description |
Example |
create_doc |
command |
Command to create a new documentation page. |
create_doc --title "Getting Started" |
update_doc |
command |
Command to update an existing documentation page. |
update_doc --id 123 --title "Updated Title" |
delete_doc |
command |
Command to delete a documentation page. |
delete_doc --id 123 |
list_docs |
command |
Command to list all documentation pages. |
list_docs |
User Management#
| Parameter/Command |
Type |
Description |
Example |
add_user |
command |
Command to add a new user to the documentation site. |
add_user --email user@example.com |
remove_user |
command |
Command to remove a user from the documentation site. |
remove_user --email user@example.com |
list_users |
command |
Command to list all users with access. |
list_users |
Collaboration Features#
| Parameter/Command |
Type |
Description |
Example |
invite_collaborator |
command |
Command to invite a collaborator to a document. |
invite_collaborator --email collaborator@example.com |
remove_collaborator |
command |
Command to remove a collaborator from a document. |
remove_collaborator --email collaborator@example.com |
list_collaborators |
command |
Command to list all collaborators on a document. |
list_collaborators --doc_id 123 |
Next steps#
Explore the guides that utilize these parameters and commands to enhance your experience with DocuCraft: