# Rust API client for rankvectors
Intelligent internal linking optimization API using AI.
RankVectors helps you automatically discover and implement optimal internal links
across your website to improve SEO performance and user experience.
## Key Features
- **AI-Powered Analysis**: Uses OpenAI embeddings to find optimal linking opportunities
- **Smart Crawling**: Automatically crawls and analyzes your website content
- **Automated Implementation**: Implement links via webhooks or manual instructions
- **Page-Based Plans**: Predictable pricing by number of pages monitored
- **Multi-Platform Support**: Works with any CMS or platform via REST API
## Getting Started
1. Create a project with your website URL
2. Start a crawl to analyze your content
3. Generate AI-powered link suggestions
4. Implement suggestions via API or webhook
5. Track performance and manage page usage and limits
## Authentication
Most API endpoints support authentication using your RankVectors API key.
Include your API key in the `Authorization` header:
```
Authorization: Bearer YOUR_API_KEY
```
Get your API key from your RankVectors dashboard: Settings → API Keys
**Note**: Some endpoints (marked in the documentation) support both API key authentication and web session authentication (Stack Auth).
API key authentication is required for SDK usage and external integrations like WordPress plugins.
For more information, please visit [https://rankvectors.com/docs](https://rankvectors.com/docs)
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
- API version: 1.3.1
- Package version: 1.3.1
- Generator version: 7.16.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
## Installation
Put the package under your project folder in a directory named `rankvectors` and add the following to `Cargo.toml` under `[dependencies]`:
```
rankvectors = { path = "./rankvectors" }
```
## Documentation for API Endpoints
All URIs are relative to *https://api.rankvectors.com*
*ApiKeysApi* | [**create_api_key**](docs/ApiKeysApi.md#create_api_key) | **POST** /api/api-keys | Create API key
*ApiKeysApi* | [**delete_api_key**](docs/ApiKeysApi.md#delete_api_key) | **DELETE** /api/api-keys/{id} | Delete API key
*ApiKeysApi* | [**list_api_keys**](docs/ApiKeysApi.md#list_api_keys) | **GET** /api/api-keys | List API keys
*ApiKeysApi* | [**update_api_key**](docs/ApiKeysApi.md#update_api_key) | **PATCH** /api/api-keys/{id} | Update API key
*AnalyticsApi* | [**get_project_analytics**](docs/AnalyticsApi.md#get_project_analytics) | **GET** /api/projects/{projectId}/analytics | Get project analytics
*ContentVerificationApi* | [**get_page_changes**](docs/ContentVerificationApi.md#get_page_changes) | **GET** /api/projects/{projectId}/changes | Get page changes
*ContentVerificationApi* | [**verify_content**](docs/ContentVerificationApi.md#verify_content) | **POST** /api/projects/{projectId}/verify-content | Verify page content
*CrawlingApi* | [**get_crawl_history**](docs/CrawlingApi.md#get_crawl_history) | **GET** /api/projects/{projectId}/crawl | Get crawl history
*CrawlingApi* | [**start_crawl**](docs/CrawlingApi.md#start_crawl) | **POST** /api/projects/{projectId}/crawl | Start website crawl
*ImplementationsApi* | [**get_implementation**](docs/ImplementationsApi.md#get_implementation) | **GET** /api/projects/{projectId}/implementations/{implementationId} | Get implementation details
*ImplementationsApi* | [**implement_links**](docs/ImplementationsApi.md#implement_links) | **POST** /api/projects/{projectId}/implementations | Implement link suggestions
*ImplementationsApi* | [**list_implementations**](docs/ImplementationsApi.md#list_implementations) | **GET** /api/projects/{projectId}/implementations | List implementations
*ImplementationsApi* | [**rollback_implementation**](docs/ImplementationsApi.md#rollback_implementation) | **POST** /api/projects/{projectId}/implementations/{implementationId}/rollback | Rollback implementation
*PagesApi* | [**batch_sync_pages**](docs/PagesApi.md#batch_sync_pages) | **POST** /api/projects/{projectId}/pages/batch | Batch sync pages
*PagesApi* | [**list_pages**](docs/PagesApi.md#list_pages) | **GET** /api/projects/{projectId}/pages | List pages
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/projects | Create a new project
*ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /api/projects/{projectId} | Delete a project
*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/projects/{projectId} | Get project details
*ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /api/projects | List all projects
*ProjectsApi* | [**sync_project**](docs/ProjectsApi.md#sync_project) | **POST** /api/projects/{projectId}/sync | Sync project
*SuggestionsApi* | [**delete_suggestion**](docs/SuggestionsApi.md#delete_suggestion) | **DELETE** /api/projects/{projectId}/suggestions/{suggestionId} | Delete suggestion
*SuggestionsApi* | [**generate_suggestions**](docs/SuggestionsApi.md#generate_suggestions) | **POST** /api/projects/{projectId}/suggestions | Generate link suggestions
*SuggestionsApi* | [**get_suggestions**](docs/SuggestionsApi.md#get_suggestions) | **GET** /api/projects/{projectId}/suggestions | Get link suggestions
*SuggestionsApi* | [**update_suggestion**](docs/SuggestionsApi.md#update_suggestion) | **PATCH** /api/projects/{projectId}/suggestions/{suggestionId} | Update suggestion status
*UserApi* | [**get_user_info**](docs/UserApi.md#get_user_info) | **GET** /api/user/me | Get authenticated user information
*WebhooksApi* | [**get_implementation_instructions**](docs/WebhooksApi.md#get_implementation_instructions) | **GET** /api/webhook/implement-link | Get implementation instructions
*WebhooksApi* | [**report_implementation_status**](docs/WebhooksApi.md#report_implementation_status) | **POST** /api/webhook/implement-link | Report implementation status
## Documentation For Models
- [ApiKey](docs/ApiKey.md)
- [ApiKeyResponse](docs/ApiKeyResponse.md)
- [BatchSyncPages200Response](docs/BatchSyncPages200Response.md)
- [BatchSyncPagesRequest](docs/BatchSyncPagesRequest.md)
- [ChangeResult](docs/ChangeResult.md)
- [ContentVerification](docs/ContentVerification.md)
- [Crawl](docs/Crawl.md)
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
- [CreateProjectRequest](docs/CreateProjectRequest.md)
- [CustomCredentials](docs/CustomCredentials.md)
- [DeleteProject200Response](docs/DeleteProject200Response.md)
- [DeleteSuggestion200Response](docs/DeleteSuggestion200Response.md)
- [Error](docs/Error.md)
- [GenerateSuggestions200Response](docs/GenerateSuggestions200Response.md)
- [GenerateSuggestionsRequest](docs/GenerateSuggestionsRequest.md)
- [GetImplementation200Response](docs/GetImplementation200Response.md)
- [GetPageChanges200Response](docs/GetPageChanges200Response.md)
- [GetPageChanges200ResponseSummary](docs/GetPageChanges200ResponseSummary.md)
- [GetUserInfo200Response](docs/GetUserInfo200Response.md)
- [GetUserInfo200ResponseLinks](docs/GetUserInfo200ResponseLinks.md)
- [GetUserInfo200ResponseUser](docs/GetUserInfo200ResponseUser.md)
- [Implementation](docs/Implementation.md)
- [ImplementationInstructions](docs/ImplementationInstructions.md)
- [ImplementationRequest](docs/ImplementationRequest.md)
- [ImplementationResponse](docs/ImplementationResponse.md)
- [ImplementationResult](docs/ImplementationResult.md)
- [ImplementationSummary](docs/ImplementationSummary.md)
- [LinkOpportunity](docs/LinkOpportunity.md)
- [ListImplementations200Response](docs/ListImplementations200Response.md)
- [ListPages200Response](docs/ListPages200Response.md)
- [Page](docs/Page.md)
- [PageAllowance](docs/PageAllowance.md)
- [PageAllowanceInfo](docs/PageAllowanceInfo.md)
- [PageAllowanceUsageHistoryInner](docs/PageAllowanceUsageHistoryInner.md)
- [PageChange](docs/PageChange.md)
- [PageChangePage](docs/PageChangePage.md)
- [PageData](docs/PageData.md)
- [PageInfo](docs/PageInfo.md)
- [PageLimitStatus](docs/PageLimitStatus.md)
- [PagePricing](docs/PagePricing.md)
- [PagePricingPagePacksInner](docs/PagePricingPagePacksInner.md)
- [PagePricingTiersInner](docs/PagePricingTiersInner.md)
- [PeriodCharges](docs/PeriodCharges.md)
- [Project](docs/Project.md)
- [ProjectAnalytics](docs/ProjectAnalytics.md)
- [ProjectAnalyticsContentStats](docs/ProjectAnalyticsContentStats.md)
- [ProjectAnalyticsImplementationStats](docs/ProjectAnalyticsImplementationStats.md)
- [ProjectAnalyticsSuggestionStats](docs/ProjectAnalyticsSuggestionStats.md)
- [ProjectAnalyticsSyncStats](docs/ProjectAnalyticsSyncStats.md)
- [ProjectCount](docs/ProjectCount.md)
- [ReportImplementationStatus200Response](docs/ReportImplementationStatus200Response.md)
- [ReportImplementationStatusRequest](docs/ReportImplementationStatusRequest.md)
- [Rollback](docs/Rollback.md)
- [RollbackImplementation200Response](docs/RollbackImplementation200Response.md)
- [RollbackImplementationRequest](docs/RollbackImplementationRequest.md)
- [StartCrawlRequest](docs/StartCrawlRequest.md)
- [StepByStepInstructions](docs/StepByStepInstructions.md)
- [Suggestion](docs/Suggestion.md)
- [SyncProject200Response](docs/SyncProject200Response.md)
- [SyncProjectRequest](docs/SyncProjectRequest.md)
- [UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
- [UpdateSuggestionRequest](docs/UpdateSuggestionRequest.md)
- [UsageHistoryItem](docs/UsageHistoryItem.md)
- [VerifyContent200Response](docs/VerifyContent200Response.md)
- [VerifyContentRequest](docs/VerifyContentRequest.md)
To get access to the crate's generated documentation, use:
```
cargo doc --open
```
## Author
tj@rankvectors.com